summaryrefslogtreecommitdiffstats
path: root/Doc/library/site.rst
diff options
context:
space:
mode:
authorÉric Araujo <merwok@netwok.org>2011-08-19 06:34:52 (GMT)
committerÉric Araujo <merwok@netwok.org>2011-08-19 06:34:52 (GMT)
commite68d4504fd6b033536ff6dec489dc6bea4dd470b (patch)
treed708fd0bd86582d4a898b168d86381c0053e4e12 /Doc/library/site.rst
parentafd2fe2aea94762a286c8cb5f758290c174d92fd (diff)
downloadcpython-e68d4504fd6b033536ff6dec489dc6bea4dd470b.zip
cpython-e68d4504fd6b033536ff6dec489dc6bea4dd470b.tar.gz
cpython-e68d4504fd6b033536ff6dec489dc6bea4dd470b.tar.bz2
Add documentation for PEP 370 features in distutils (#10745).
Apart from adding a section to describe the user scheme, this changeset also does some much needed cleanup: - fixed inverted reST targets - fixed some paths - 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 does not use these files anymore since the Great Revert. I suspect we have a mismatched stdlib at the moment, and the fix is not even clear (see discussion on #8084).
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 5e11e22..c0fafed 100644
--- a/Doc/library/site.rst
+++ b/Doc/library/site.rst
@@ -138,14 +138,16 @@ 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`.
.. versionadded:: 2.6
.. 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()