diff options
author | Benjamin Peterson <benjamin@python.org> | 2017-02-10 06:31:17 (GMT) |
---|---|---|
committer | Benjamin Peterson <benjamin@python.org> | 2017-02-10 06:31:17 (GMT) |
commit | 35a1f7f62df4380c8fbc5b6d64ee6bb8162d69f4 (patch) | |
tree | fc2b36f4a1101be24f6edd4fc72ce54a3ca4474b /Doc | |
parent | d43ab05916639d478877d049f6dde4927f429190 (diff) | |
download | cpython-35a1f7f62df4380c8fbc5b6d64ee6bb8162d69f4.zip cpython-35a1f7f62df4380c8fbc5b6d64ee6bb8162d69f4.tar.gz cpython-35a1f7f62df4380c8fbc5b6d64ee6bb8162d69f4.tar.bz2 |
massage English for -X descriptions a bit
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/using/cmdline.rst | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst index c0e64d6..195f63f 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -396,21 +396,23 @@ Miscellaneous options defines the following possible values: * ``-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 showrefcount`` to output the total reference count and number of used + memory blocks when the program finishes or after each statement in the + interactive interpreter. This only works on debug builds. * ``-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. - * ``-X showalloccount`` to enable the output of the total count of allocated - objects for each type (only works when built with ``COUNT_ALLOCS`` defined); + * ``-X showalloccount`` to output the total count of allocated objects for + each type when the program finishes. This only works when Python was built with + ``COUNT_ALLOCS`` defined. It also allows passing arbitrary values and retrieving them through the :data:`sys._xoptions` dictionary. .. versionchanged:: 3.2 - It is now allowed to pass :option:`-X` with CPython. + The :option:`-X` option was added. .. versionadded:: 3.3 The ``-X faulthandler`` option. |