Skip to content

Commit f89bff5

Browse files
furkanonderaisk
authored andcommitted
pythonGH-83893: Cross reference env. vars and -X command line options (pythonGH-103414)
Co-authored-by: Erlend E. Aasland
1 parent 14f6c7c commit f89bff5

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

Doc/using/cmdline.rst

+12-6
Original file line numberDiff line numberDiff line change
@@ -495,16 +495,18 @@ Miscellaneous options
495495
Reserved for various implementation-specific options. CPython currently
496496
defines the following possible values:
497497

498-
* ``-X faulthandler`` to enable :mod:`faulthandler`;
498+
* ``-X faulthandler`` to enable :mod:`faulthandler`.
499+
See also :envvar:`PYTHONFAULTHANDLER`.
499500
* ``-X showrefcount`` to output the total reference count and number of used
500501
memory blocks when the program finishes or after each statement in the
501502
interactive interpreter. This only works on :ref:`debug builds
502503
<debug-build>`.
503504
* ``-X tracemalloc`` to start tracing Python memory allocations using the
504505
:mod:`tracemalloc` module. By default, only the most recent frame is
505506
stored in a traceback of a trace. Use ``-X tracemalloc=NFRAME`` to start
506-
tracing with a traceback limit of *NFRAME* frames. See the
507-
:func:`tracemalloc.start` for more information.
507+
tracing with a traceback limit of *NFRAME* frames.
508+
See :func:`tracemalloc.start` and :envvar:`PYTHONTRACEMALLOC`
509+
for more information.
508510
* ``-X int_max_str_digits`` configures the :ref:`integer string conversion
509511
length limitation <int_max_str_digits>`. See also
510512
:envvar:`PYTHONINTMAXSTRDIGITS`.
@@ -519,6 +521,7 @@ Miscellaneous options
519521
* ``-X utf8`` enables the :ref:`Python UTF-8 Mode <utf8-mode>`.
520522
``-X utf8=0`` explicitly disables :ref:`Python UTF-8 Mode <utf8-mode>`
521523
(even when it would otherwise activate automatically).
524+
See also :envvar:`PYTHONUTF8`.
522525
* ``-X pycache_prefix=PATH`` enables writing ``.pyc`` files to a parallel
523526
tree rooted at the given directory instead of to the code tree. See also
524527
:envvar:`PYTHONPYCACHEPREFIX`.
@@ -861,16 +864,18 @@ conflict.
861864
Python memory allocations using the :mod:`tracemalloc` module. The value of
862865
the variable is the maximum number of frames stored in a traceback of a
863866
trace. For example, ``PYTHONTRACEMALLOC=1`` stores only the most recent
864-
frame. See the :func:`tracemalloc.start` for more information.
867+
frame.
868+
See the :func:`tracemalloc.start` function for more information.
869+
This is equivalent to setting the :option:`-X` ``tracemalloc`` option.
865870

866871
.. versionadded:: 3.4
867872

868873

869874
.. envvar:: PYTHONPROFILEIMPORTTIME
870875

871876
If this environment variable is set to a non-empty string, Python will
872-
show how long each import takes. This is exactly equivalent to setting
873-
``-X importtime`` on the command line.
877+
show how long each import takes.
878+
This is equivalent to setting the :option:`-X` ``importtime`` option.
874879

875880
.. versionadded:: 3.7
876881

@@ -1012,6 +1017,7 @@ conflict.
10121017
If this environment variable is set to a non-empty string, enable
10131018
:ref:`Python Development Mode <devmode>`, introducing additional runtime
10141019
checks that are too expensive to be enabled by default.
1020+
This is equivalent to setting the :option:`-X` ``dev`` option.
10151021

10161022
.. versionadded:: 3.7
10171023

0 commit comments

Comments
 (0)