summaryrefslogtreecommitdiffstats
path: root/Doc/using
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2013-11-23 11:37:20 (GMT)
committerVictor Stinner <victor.stinner@gmail.com>2013-11-23 11:37:20 (GMT)
commit3728d6ced09eb3adac2e9fec6be38e1598720067 (patch)
tree70008dae2aea975cb3604173bdccfd66ac2d79cc /Doc/using
parented3b0bca3ef9d7bdbb8bd8e67e60e85f5a336da0 (diff)
downloadcpython-3728d6ced09eb3adac2e9fec6be38e1598720067.zip
cpython-3728d6ced09eb3adac2e9fec6be38e1598720067.tar.gz
cpython-3728d6ced09eb3adac2e9fec6be38e1598720067.tar.bz2
Issue #18874: Remove tracemalloc.set_traceback_limit()
tracemalloc.start() now has an option nframe parameter
Diffstat (limited to 'Doc/using')
-rw-r--r--Doc/using/cmdline.rst18
1 files changed, 10 insertions, 8 deletions
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
index cfd6045..d1822fb 100644
--- a/Doc/using/cmdline.rst
+++ b/Doc/using/cmdline.rst
@@ -381,10 +381,11 @@ Miscellaneous options
* ``-X faulthandler`` to enable :mod:`faulthandler`;
* ``-X showrefcount`` to enable the output of the total reference count
and memory blocks (only works on debug builds);
- * ``-X tracemalloc`` to enable :mod:`tracemalloc`.
- * ``-X tracemalloc=NFRAME`` to enable :mod:`tracemalloc`, *NFRAME* is the
- maximum number of frames stored in a trace: see the
- :func:`tracemalloc.set_traceback_limit` function.
+ * ``-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
+ tracing with a traceback limit of *NFRAME* frames. See the
+ :func:`tracemalloc.start` for more information.
It also allows to pass arbitrary values and retrieve them through the
:data:`sys._xoptions` dictionary.
@@ -600,10 +601,11 @@ conflict.
.. envvar:: PYTHONTRACEMALLOC
- If this environment variable is set to a non-empty string, all memory
- allocations made by Python are traced by the :mod:`tracemalloc` module.
- The value of the variable is the maximum number of frames stored in a trace:
- see the :func:`tracemalloc.set_traceback_limit` function.
+ If this environment variable is set to a non-empty string, start tracing
+ Python memory allocations using the :mod:`tracemalloc` module. The value of
+ the variable is the maximum number of frames stored in a traceback of a
+ trace. For example, ``PYTHONTRACEMALLOC=1`` stores only the most recent
+ frame. See the :func:`tracemalloc.start` for more information.
.. versionadded:: 3.4