diff options
| author | Victor Stinner <victor.stinner@gmail.com> | 2016-03-18 10:04:31 (GMT) |
|---|---|---|
| committer | Victor Stinner <victor.stinner@gmail.com> | 2016-03-18 10:04:31 (GMT) |
| commit | c2fc56836f6cb02ce6436d9eb0342dc595738e9d (patch) | |
| tree | 8b36c4084231867b414009b4ee81cc1fe5267b30 /Doc/using | |
| parent | 3ca334230712ef0e1b20f046cf62a24a1117a57a (diff) | |
| download | cpython-c2fc56836f6cb02ce6436d9eb0342dc595738e9d.zip cpython-c2fc56836f6cb02ce6436d9eb0342dc595738e9d.tar.gz cpython-c2fc56836f6cb02ce6436d9eb0342dc595738e9d.tar.bz2 | |
Enhance documentation on malloc debug hooks
Issue #26564, #26516, #26563.
Diffstat (limited to 'Doc/using')
| -rw-r--r-- | Doc/using/cmdline.rst | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst index 684ccb6..4555982 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -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 |