summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/memory.rst
diff options
context:
space:
mode:
authorVictor Stinner <vstinner@python.org>2021-04-08 20:32:21 (GMT)
committerGitHub <noreply@github.com>2021-04-08 20:32:21 (GMT)
commita41782cc84bcd813209a03e6e11c60e77dbc7718 (patch)
tree76e53b2a0c0e68d1413b1a0171718e7196267cf7 /Doc/c-api/memory.rst
parentd92c59f48680122ce0e4d1ccf69d92b983e8db01 (diff)
downloadcpython-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/memory.rst')
-rw-r--r--Doc/c-api/memory.rst13
1 files changed, 7 insertions, 6 deletions
diff --git a/Doc/c-api/memory.rst b/Doc/c-api/memory.rst
index d2d212b..b945429 100644
--- a/Doc/c-api/memory.rst
+++ b/Doc/c-api/memory.rst
@@ -385,11 +385,12 @@ Debug build, without pymalloc ``"malloc_debug"`` ``malloc`` + debug ``mal
Legend:
-* Name: value for :envvar:`PYTHONMALLOC` environment variable
+* Name: value for :envvar:`PYTHONMALLOC` environment variable.
* ``malloc``: system allocators from the standard C library, C functions:
- :c:func:`malloc`, :c:func:`calloc`, :c:func:`realloc` and :c:func:`free`
-* ``pymalloc``: :ref:`pymalloc memory allocator <pymalloc>`
-* "+ debug": with debug hooks installed by :c:func:`PyMem_SetupDebugHooks`
+ :c:func:`malloc`, :c:func:`calloc`, :c:func:`realloc` and :c:func:`free`.
+* ``pymalloc``: :ref:`pymalloc memory allocator <pymalloc>`.
+* "+ debug": with debug hooks installed by :c:func:`PyMem_SetupDebugHooks`.
+* "Debug build": :ref:`Python build in debug mode <debug-build>`.
.. _customize-memory-allocators:
@@ -500,8 +501,8 @@ Customize Memory Allocators
memory block was traced.
These hooks are :ref:`installed by default <default-memory-allocators>` if
- Python is compiled in debug
- mode. The :envvar:`PYTHONMALLOC` environment variable can be used to install
+ :ref:`Python is built in debug mode <debug-build>`.
+ The :envvar:`PYTHONMALLOC` environment variable can be used to install
debug hooks on a Python compiled in release mode.
.. versionchanged:: 3.6