diff options
author | Victor Stinner <vstinner@python.org> | 2021-04-08 20:32:21 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-04-08 20:32:21 (GMT) |
commit | a41782cc84bcd813209a03e6e11c60e77dbc7718 (patch) | |
tree | 76e53b2a0c0e68d1413b1a0171718e7196267cf7 /Doc/c-api/intro.rst | |
parent | d92c59f48680122ce0e4d1ccf69d92b983e8db01 (diff) | |
download | cpython-a41782cc84bcd813209a03e6e11c60e77dbc7718.zip cpython-a41782cc84bcd813209a03e6e11c60e77dbc7718.tar.gz cpython-a41782cc84bcd813209a03e6e11c60e77dbc7718.tar.bz2 |
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/c-api/intro.rst')
-rw-r--r-- | Doc/c-api/intro.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/c-api/intro.rst b/Doc/c-api/intro.rst index bae5ce1..1223059 100644 --- a/Doc/c-api/intro.rst +++ b/Doc/c-api/intro.rst @@ -742,9 +742,10 @@ allocator, or low-level profiling of the main interpreter loop. Only the most frequently-used builds will be described in the remainder of this section. Compiling the interpreter with the :c:macro:`Py_DEBUG` macro defined produces -what is generally meant by "a debug build" of Python. :c:macro:`Py_DEBUG` is -enabled in the Unix build by adding ``--with-pydebug`` to the -:file:`./configure` command. It is also implied by the presence of the +what is generally meant by :ref:`a debug build of Python <debug-build>`. +:c:macro:`Py_DEBUG` is enabled in the Unix build by adding +:option:`--with-pydebug` to the :file:`./configure` command. +It is also implied by the presence of the not-Python-specific :c:macro:`_DEBUG` macro. When :c:macro:`Py_DEBUG` is enabled in the Unix build, compiler optimization is disabled. @@ -778,7 +779,7 @@ Defining :c:macro:`Py_TRACE_REFS` enables reference tracing. When defined, a circular doubly linked list of active objects is maintained by adding two extra fields to every :c:type:`PyObject`. Total allocations are tracked as well. Upon exit, all existing references are printed. (In interactive mode this happens -after every statement run by the interpreter.) Implied by :c:macro:`Py_DEBUG`. +after every statement run by the interpreter.) Please refer to :file:`Misc/SpecialBuilds.txt` in the Python source distribution for more detailed information. |