mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-20 13:43:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

bpo-45788: Link sys.prefix doc to 'Installation paths' (#29606)

Browse source 
... To the Installation paths section of the sysconfig doc.
This commit is contained in:
Terry Jan Reedy 2021-11-18 15:08:24 -05:00 • committed by GitHub
parent 32959108f9
commit 4575c01b75
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Doc/library/sys.rst
View file

@ -1216,13 +1216,10 @@ always available.
.. data:: prefix .. data:: prefix
A string giving the site-specific directory prefix where the platform A string giving the site-specific directory prefix where the platform
independent Python files are installed; by default, this is the string independent Python files are installed; on Unix, the default is
``'/usr/local'``. This can be set at build time with the ``--prefix`` ``'/usr/local'``. This can be set at build time with the ``--prefix``
argument to the :program:`configure` script. The main collection of Python argument to the :program:`configure` script. See
library modules is installed in the directory :file:`{prefix}/lib/python{X.Y}` :ref:`installation_paths` for derived paths.
while the platform independent header files (all except :file:`pyconfig.h`) are
stored in :file:`{prefix}/include/python{X.Y}`, where *X.Y* is the version
number of Python, for example ``3.2``.
.. note:: If a :ref:`virtual environment <venv-def>` is in effect, this .. note:: If a :ref:`virtual environment <venv-def>` is in effect, this
value will be changed in ``site.py`` to point to the virtual value will be changed in ``site.py`` to point to the virtual

4
Doc/library/sysconfig.rst
View file

@ -60,6 +60,7 @@ Example of usage::
>>> sysconfig.get_config_vars('AR', 'CXX') >>> sysconfig.get_config_vars('AR', 'CXX')
['ar', 'g++'] ['ar', 'g++']
.. _installation_paths:
Installation paths Installation paths
------------------ ------------------
@ -72,7 +73,7 @@ Every new component that is installed using :mod:`distutils` or a
Distutils-based system will follow the same scheme to copy its file in the right Distutils-based system will follow the same scheme to copy its file in the right
places. places.
Python currently supports seven schemes: Python currently supports six schemes:
- *posix_prefix*: scheme for POSIX platforms like Linux or macOS. This is - *posix_prefix*: scheme for POSIX platforms like Linux or macOS. This is
the default scheme used when Python or a component is installed. the default scheme used when Python or a component is installed.
@ -84,6 +85,7 @@ Python currently supports seven schemes:
located under the user home directory. located under the user home directory.
- *nt*: scheme for NT platforms like Windows. - *nt*: scheme for NT platforms like Windows.
- *nt_user*: scheme for NT platforms, when the *user* option is used. - *nt_user*: scheme for NT platforms, when the *user* option is used.
- *osx_framework_user*: scheme for macOS, when the *user* option is used.
Each scheme is itself composed of a series of paths and each path has a unique Each scheme is itself composed of a series of paths and each path has a unique
identifier. Python currently uses eight paths: identifier. Python currently uses eight paths:

1
Misc/NEWS.d/next/Documentation/2021-11-18-00-07-40.bpo-45788.qibUoB.rst Normal file
View file

@ -0,0 +1 @@
Link doc for sys.prefix to sysconfig doc on installation paths.