[Python-checkins] distutils2: Added documentation about extra_path. Original patch by Ronald Oussoren

[tarek.ziade]

tarek.ziade pushed 121bdbb58399 to distutils2:

http://hg.python.org/distutils2/rev/121bdbb58399
changeset:   1022:121bdbb58399
user:        Alexis Metaireau <alexis at notmyidea.org>
date:        Sun Feb 13 14:33:09 2011 +0000
summary:
  Added documentation about extra_path. Original patch by Ronald Oussoren

files:
  docs/source/distutils/apiref.rst

diff --git a/docs/source/distutils/apiref.rst b/docs/source/distutils/apiref.rst
--- a/docs/source/distutils/apiref.rst
+++ b/docs/source/distutils/apiref.rst
@@ -104,6 +104,26 @@
    | *package_dir*      | A mapping of package to        | a dictionary                                                |
    |                    | directory names                |                                                             |
    +--------------------+--------------------------------+-------------------------------------------------------------+
+   | *extra_path*       | Information about an           | a string, 1-tuple or 2-tuple                                |
+   |                    | intervening directory the      |                                                             |
+   |                    | install directory and the      |                                                             |
+   |                    | actual installation directory. |                                                             |
+   |                    |                                |                                                             |
+   |                    | If the value is a string is is |                                                             |
+   |                    | treated as a comma-separated   |                                                             |
+   |                    | tuple.                         |                                                             |
+   |                    |                                |                                                             |
+   |                    | If the value is a 2-tuple,     |                                                             |
+   |                    | the first element is the       |                                                             |
+   |                    | ``.pth`` file and the second   |                                                             |
+   |                    | is the name of the intervening |                                                             |
+   |                    | directory.                     |                                                             |
+   |                    |                                |                                                             |
+   |                    | If the value is a 1-tuple that |                                                             |
+   |                    | element is both the name of    |                                                             |
+   |                    | the ``.pth`` file and the      |                                                             |
+   |                    | intervening directory.         |                                                             |
+   +--------------------+--------------------------------+-------------------------------------------------------------+
 
 
 

--
Repository URL: http://hg.python.org/distutils2