diff options
| author | Julien Palard <julien@palard.fr> | 2023-03-15 15:10:03 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-15 15:10:03 (GMT) |
| commit | 61b9ff35cbda0cc59816951a17de073968fc25c6 (patch) | |
| tree | 50772e4807d00fd09a471769a747c47589a2fae4 /Doc/c-api | |
| parent | afa6092ee4260bacf7bc11905466e4c3f8556cbb (diff) | |
| download | cpython-61b9ff35cbda0cc59816951a17de073968fc25c6.zip cpython-61b9ff35cbda0cc59816951a17de073968fc25c6.tar.gz cpython-61b9ff35cbda0cc59816951a17de073968fc25c6.tar.bz2 | |
gh-101100: Documenting --prefix and --exec-prefix. (GH-102695)
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Diffstat (limited to 'Doc/c-api')
| -rw-r--r-- | Doc/c-api/init.rst | 2 | ||||
| -rw-r--r-- | Doc/c-api/intro.rst | 10 |
2 files changed, 6 insertions, 6 deletions
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst index b50ee3b..38e324f 100644 --- a/Doc/c-api/init.rst +++ b/Doc/c-api/init.rst @@ -513,7 +513,7 @@ Process-wide parameters program name is ``'/usr/local/bin/python'``, the prefix is ``'/usr/local'``. The returned string points into static storage; the caller should not modify its value. This corresponds to the :makevar:`prefix` variable in the top-level - :file:`Makefile` and the ``--prefix`` argument to the :program:`configure` + :file:`Makefile` and the :option:`--prefix` argument to the :program:`configure` script at build time. The value is available to Python code as ``sys.prefix``. It is only useful on Unix. See also the next function. diff --git a/Doc/c-api/intro.rst b/Doc/c-api/intro.rst index 85eb24a..acd4e03 100644 --- a/Doc/c-api/intro.rst +++ b/Doc/c-api/intro.rst @@ -78,19 +78,19 @@ used by extension writers. Structure member names do not have a reserved prefix. The header files are typically installed with Python. On Unix, these are located in the directories :file:`{prefix}/include/pythonversion/` and -:file:`{exec_prefix}/include/pythonversion/`, where :envvar:`prefix` and -:envvar:`exec_prefix` are defined by the corresponding parameters to Python's +:file:`{exec_prefix}/include/pythonversion/`, where :option:`prefix <--prefix>` and +:option:`exec_prefix <--exec-prefix>` are defined by the corresponding parameters to Python's :program:`configure` script and *version* is ``'%d.%d' % sys.version_info[:2]``. On Windows, the headers are installed -in :file:`{prefix}/include`, where :envvar:`prefix` is the installation +in :file:`{prefix}/include`, where ``prefix`` is the installation directory specified to the installer. To include the headers, place both directories (if different) on your compiler's search path for includes. Do *not* place the parent directories on the search path and then use ``#include <pythonX.Y/Python.h>``; this will break on multi-platform builds since the platform independent headers under -:envvar:`prefix` include the platform specific headers from -:envvar:`exec_prefix`. +:option:`prefix <--prefix>` include the platform specific headers from +:option:`exec_prefix <--exec-prefix>`. C++ users should note that although the API is defined entirely using C, the header files properly declare the entry points to be ``extern "C"``. As a result, |