diff options
author | Victor Stinner <vstinner@python.org> | 2021-04-08 22:32:21 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-04-08 22:32:21 +0200 |
commit | a41782cc84bcd813209a03e6e11c60e77dbc7718 (patch) | |
tree | 76e53b2a0c0e68d1413b1a0171718e7196267cf7 /Doc/using/cmdline.rst | |
parent | d92c59f48680122ce0e4d1ccf69d92b983e8db01 (diff) | |
download | cpython-git-a41782cc84bcd813209a03e6e11c60e77dbc7718.tar.gz |
bpo-43774: Document configure options (GH-25283)
Add Doc/using/configure.rst documentation to document configure,
preprocessor, compiler and linker options.
Add a new section about the "Python debug build".
Diffstat (limited to 'Doc/using/cmdline.rst')
-rw-r--r-- | Doc/using/cmdline.rst | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst index 1493c7c901..a39cfd6882 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -433,7 +433,8 @@ Miscellaneous options * ``-X faulthandler`` to enable :mod:`faulthandler`; * ``-X showrefcount`` to output the total reference count and number of used memory blocks when the program finishes or after each statement in the - interactive interpreter. This only works on debug builds. + interactive interpreter. This only works on :ref:`debug builds + <debug-build>`. * ``-X tracemalloc`` to start tracing Python memory allocations using the :mod:`tracemalloc` module. By default, only the most recent frame is stored in a traceback of a trace. Use ``-X tracemalloc=NFRAME`` to start @@ -926,13 +927,11 @@ conflict. Debug-mode variables ~~~~~~~~~~~~~~~~~~~~ -Setting these variables only has an effect in a debug build of Python. - .. envvar:: PYTHONTHREADDEBUG If set, Python will print threading debug info. - Need Python configured with the ``--with-pydebug`` build option. + Need a :ref:`debug build of Python <debug-build>`. .. envvar:: PYTHONDUMPREFS @@ -940,4 +939,4 @@ Setting these variables only has an effect in a debug build of Python. If set, Python will dump objects and reference counts still alive after shutting down the interpreter. - Need Python configured with the ``--with-trace-refs`` build option. + Need Python configured with the :option:`--with-trace-refs` build option. |