8000 gh-101100: Documenting --prefix and --exec-prefix. (GH-102695) · python/cpython@3ddf397 · GitHub
[go: up one dir, main page]
Skip to content

Commit 3ddf397

Browse files
miss-islingtonJulienPalarderlend-aasland
authored
gh-101100: Documenting --prefix and --exec-prefix. (GH-102695)
(cherry picked from commit 61b9ff3) Co-authored-by: Julien Palard <julien@palard.fr> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
1 parent 7e5ba35 commit 3ddf397

File tree

5 files changed

+24
-8
lines changed

5 files changed

+24
-8
lines changed

‎Doc/c-api/init.rst

Original file line numberDiff line numberDiff line change
@@ -404,7 +404,7 @@ Process-wide parameters
404404
program name is ``'/usr/local/bin/python'``, the prefix is ``'/usr/local'``. The
405405
returned string points into static storage; the caller should not modify its
406406
value. This corresponds to the :makevar:`prefix` variable in the top-level
407-
:file:`Makefile` and the ``--prefix`` argument to the :program:`configure`
407+
:file:`Makefile` and the :option:`--prefix` argument to the :program:`configure`
408408
script at build time. The value is available to Python code as ``sys.prefix``.
409409
It is only useful on Unix. See also the next function.
410410

‎Doc/c-api/intro.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,19 +78,19 @@ used by extension writers. Structure member names do not have a reserved prefix.
7878

7979
The header files are typically installed with Python. On Unix, these are
8080
located in the directories :file:`{prefix}/include/pythonversion/` and
81-
:file:`{exec_prefix}/include/pythonversion/`, where :envvar:`prefix` and
82-
:envvar:`exec_prefix` are defined by the corresponding parameters to Python's
81+
:file:`{exec_prefix}/include/pythonversion/`, where :option:`prefix <--prefix>` and
82+
:option:`exec_prefix <--exec-prefix>` are defined by the corresponding parameters to Python's
8383
:program:`configure` script and *version* is
8484
``'%d.%d' % sys.version_info[:2]``. On Windows, the headers are installed
85-
in :file:`{prefix}/include`, where :envvar:`prefix` is the installation
85+
in :file:`{prefix}/include`, where ``prefix`` is the installation
8686
directory specified to the installer.
8787

8888
To include the headers, place both directories (if different) on your compiler's
8989
search path for includes. Do *not* place the parent directories on the search
9090
path and then use ``#include <pythonX.Y/Python.h>``; this will break on
9191
multi-platform builds since the platform independent headers under
92-
:envvar:`prefix` include the platform specific headers from
93-
:envvar:`exec_prefix`.
92+
:option:`prefix <--prefix>` include the platform specific headers from
93+
:option:`exec_prefix <--exec-prefix>`.
9494

9595
C++ users should note that although the API is defined entirely using C, the
9696
header files properly declare the entry points to be ``extern "C"``. As a result,

‎Doc/library/sys.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1307,7 +1307,7 @@ always available.
13071307

13081308
A string giving the site-specific directory prefix where the platform
13091309
independent Python files are installed; on Unix, the default is
1310-
``'/usr/local'``. This can be set at build time with the ``--prefix``
1310+
:file:`/usr/local`. This can be set at build time with the :option:`--prefix`
13111311
argument to the :program:`configure` script. See
13121312
:ref:`installation_paths` for derived paths.
13131313

‎Doc/using/configure.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,22 @@ WebAssembly Options
174174
Install Options
175175
---------------
176176

177+
.. cmdoption:: --prefix=PREFIX
178+
179+
Install architecture-independent files in PREFIX. On Unix, it
180+
defaults to :file:`/usr/local`.
181+
182+
This value can be retrived at runtime using :data:`sys.prefix`.
183+
184+
As an example, one can use ``--prefix="$HOME/.local/"`` to install
185+
a Python in its home directory.
186+
187+
.. cmdoption:: --exec-prefix=EPREFIX
188+
189+
Install architecture-dependent files in EPREFIX, defaults to :option:`--prefix`.
190+
191+
This value can be retrived at runtime using :data:`sys.exec_prefix`.
192+
177193
.. cmdoption:: --disable-test-modules
178194

179195
Don't build nor install test modules, like the :mod:`test` package or the

‎Doc/using/unix.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Python-related paths and files
9393
==============================
9494

9595
These are subject to difference depending on local installation conventions;
96-
:envvar:`prefix` (``${prefix}``) and :envvar:`exec_prefix` (``${exec_prefix}``)
96+
:option:`prefix <--prefix>` and :option:`exec_prefix <--exec-prefix>`
9797
are installation-dependent and should be interpreted as for GNU software; they
9898
may be the same.
9999

0 commit comments

Comments
 (0)
0