8000 bpo-45788: Link sys.prefix doc to 'Installation paths' by terryjreedy · Pull Request #29606 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions Doc/library/sys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1216,13 +1216,10 @@ always available.
.. data:: prefix

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``
argument to the :program:`configure` script. The main collection of Python
library modules is installed in the directory :file:`{prefix}/lib/python{X.Y}`
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``.
argument to the :program:`configure` script. See
:ref:`installation_paths` for derived paths.

.. note:: If a :ref:`virtual environment <venv-def>` is in effect, this
value will be changed in ``site.py`` to point to the virtual
Expand Down
4 changes: 3 additions & 1 deletion Doc/library/sysconfig.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Example of usage::
>>> sysconfig.get_config_vars('AR', 'CXX')
['ar', 'g++']

.. _installation_paths:

Installation paths
------------------
Expand All @@ -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
places.

Python currently supports seven schemes:
Python currently supports six schemes:

- *posix_prefix*: scheme for POSIX platforms like Linux or macOS. This is
the default scheme used when Python or a component is installed.
Expand All @@ -84,6 +85,7 @@ Python currently supports seven schemes:
located under the user home directory.
- *nt*: scheme for NT platforms like Windows.
- *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
identifier. Python currently uses eight paths:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Link doc for sys.prefix to sysconfig doc on installation paths.
0