Enhance documentation on malloc debug hooks

Issue #26564, #26516, #26563.
This commit is contained in:
Victor Stinner 2016-03-18 11:04:31 +01:00
parent 3ca3342307
commit c2fc56836f
3 changed files with 20 additions and 11 deletions

View file

@ -638,16 +638,20 @@ conflict.
Install debug hooks:
* ``debug``: install debug hooks on top of the default memory allocator
* ``malloc_debug``: same than ``malloc`` but also install debug hooks
* ``pymalloc_debug``: same than ``malloc`` but also install debug hooks
* ``malloc_debug``: same as ``malloc`` but also install debug hooks
* ``pymalloc_debug``: same as ``pyalloc`` but also install debug hooks
When is compiled in release mode, the default is ``pymalloc``. When Python
is compiled in debug mode, the default is ``pymalloc_debug``: debug hooks
are installed.
If Python is configured without ``pymalloc`` support, ``pymalloc`` and
``pymalloc_debug`` are not available, the default is ``malloc`` in release
mode and ``malloc_debug`` in debug mode.
See the :c:func:`PyMem_SetupDebugHooks` function for debug hooks on Python
memory allocators.
.. note::
``pymalloc`` and ``pymalloc_debug`` are not available if Python is
configured without ``pymalloc`` support.
.. versionadded:: 3.6