summaryrefslogtreecommitdiffstats
path: root/Doc/library/site.rst
diff options
context:
space:
mode:
authorÉric Araujo <merwok@netwok.org>2011-08-06 14:30:42 (GMT)
committerÉric Araujo <merwok@netwok.org>2011-08-06 14:30:42 (GMT)
commit6ef038e78c0c76e77b2561a154182264b7b9907a (patch)
tree1767930e70a0d9445dd4309584939cf080316831 /Doc/library/site.rst
parentde4f05b741aacf545d2fb844329d930877117ee2 (diff)
downloadcpython-6ef038e78c0c76e77b2561a154182264b7b9907a.zip
cpython-6ef038e78c0c76e77b2561a154182264b7b9907a.tar.gz
cpython-6ef038e78c0c76e77b2561a154182264b7b9907a.tar.bz2
Add documentation for PEP 370 features in distutils (#10745).
This started out as an easy task, just add a section describing this alternate scheme, but I found a lot of cleanup to do along the way: - fixed inverted reST targets - fixed entries for modules (hi abiflags!) or data files - avoided duplicating the same options listing five or six times - added missing entries for C headers locations - added documentation for --install-lib - fixed a few misuses of the option role (see #9312), but not all (not worth the time, but will do it in packaging docs) - fixed some markup The paths fixes were done with an eye on the source code in the install command, so they really describe what’s actually done. The situation on Mac OS X is rather messy: the fix for #8084 touched site and sysconfig, but distutils doesn’t use these files. I suspect we have a mismatched stdlib at the moment, and the fix is not even clear (see the bug report for further discussion).
Diffstat (limited to 'Doc/library/site.rst')
-rw-r--r--Doc/library/site.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/library/site.rst b/Doc/library/site.rst
index adab800..db96add 100644
--- a/Doc/library/site.rst
+++ b/Doc/library/site.rst
@@ -129,12 +129,14 @@ empty, and the path manipulations are skipped; however the import of
:file:`~/Library/Python/{X.Y}` for Mac framework builds, and
:file:`{%APPDATA%}\\Python` for Windows. This value is used by Distutils to
compute the installation directories for scripts, data files, Python modules,
- etc. See also :envvar:`PYTHONUSERBASE`.
+ etc. for the :ref:`user installation scheme <inst-alt-install-user>`. See
+ also :envvar:`PYTHONUSERBASE`.
.. function:: addsitedir(sitedir, known_paths=None)
- Add a directory to sys.path and process its :file:`.pth` files.
+ Add a directory to sys.path and process its :file:`.pth` files. Typically
+ used in :mod:`sitecustomize` or :mod:`usercustomize` (see above).
.. function:: getsitepackages()