Skip to content

Commit 35a1f7f

Browse files
committed
massage English for -X descriptions a bit
1 parent d43ab05 commit 35a1f7f

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

Doc/using/cmdline.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -396,21 +396,23 @@ Miscellaneous options
396396
defines the following possible values:
397397

398398
* ``-X faulthandler`` to enable :mod:`faulthandler`;
399-
* ``-X showrefcount`` to enable the output of the total reference count
400-
and memory blocks (only works on debug builds);
399+
* ``-X showrefcount`` to output the total reference count and number of used
400+
memory blocks when the program finishes or after each statement in the
401+
interactive interpreter. This only works on debug builds.
401402
* ``-X tracemalloc`` to start tracing Python memory allocations using the
402403
:mod:`tracemalloc` module. By default, only the most recent frame is
403404
stored in a traceback of a trace. Use ``-X tracemalloc=NFRAME`` to start
404405
tracing with a traceback limit of *NFRAME* frames. See the
405406
:func:`tracemalloc.start` for more information.
406-
* ``-X showalloccount`` to enable the output of the total count of allocated
407-
objects for each type (only works when built with ``COUNT_ALLOCS`` defined);
407+
* ``-X showalloccount`` to output the total count of allocated objects for
408+
each type when the program finishes. This only works when Python was built with
409+
``COUNT_ALLOCS`` defined.
408410

409411
It also allows passing arbitrary values and retrieving them through the
410412
:data:`sys._xoptions` dictionary.
411413

412414
.. versionchanged:: 3.2
413-
It is now allowed to pass :option:`-X` with CPython.
415+
The :option:`-X` option was added.
414416

415417
.. versionadded:: 3.3
416418
The ``-X faulthandler`` option.

0 commit comments

Comments
 (0)