summaryrefslogtreecommitdiffstats
path: root/Doc/using
diff options
context:
space:
mode:
authorFurkan Onder <furkanonder@protonmail.com>2023-04-12 08:44:35 (GMT)
committerGitHub <noreply@github.com>2023-04-12 08:44:35 (GMT)
commitd65ed693a8a13a2a7f9b201bda1224d6ae5fcf0e (patch)
tree973ed78efaf0c223bacfdfd8fccecd6bfce33f0d /Doc/using
parent8f54302ab49a07e857843f1a551db5ddb536ce56 (diff)
downloadcpython-d65ed693a8a13a2a7f9b201bda1224d6ae5fcf0e.zip
cpython-d65ed693a8a13a2a7f9b201bda1224d6ae5fcf0e.tar.gz
cpython-d65ed693a8a13a2a7f9b201bda1224d6ae5fcf0e.tar.bz2
GH-83893: Cross reference env. vars and -X command line options (GH-103414)
Co-authored-by: Erlend E. Aasland
Diffstat (limited to 'Doc/using')
-rw-r--r--Doc/using/cmdline.rst18
1 files changed, 12 insertions, 6 deletions
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
index 2a4d070..b35e845 100644
--- a/Doc/using/cmdline.rst
+++ b/Doc/using/cmdline.rst
@@ -495,7 +495,8 @@ Miscellaneous options
Reserved for various implementation-specific options. CPython currently
defines the following possible values:
- * ``-X faulthandler`` to enable :mod:`faulthandler`;
+ * ``-X faulthandler`` to enable :mod:`faulthandler`.
+ See also :envvar:`PYTHONFAULTHANDLER`.
* ``-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 :ref:`debug builds
@@ -503,8 +504,9 @@ Miscellaneous options
* ``-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.
+ tracing with a traceback limit of *NFRAME* frames.
+ See :func:`tracemalloc.start` and :envvar:`PYTHONTRACEMALLOC`
+ for more information.
* ``-X int_max_str_digits`` configures the :ref:`integer string conversion
length limitation <int_max_str_digits>`. See also
:envvar:`PYTHONINTMAXSTRDIGITS`.
@@ -519,6 +521,7 @@ Miscellaneous options
* ``-X utf8`` enables the :ref:`Python UTF-8 Mode <utf8-mode>`.
``-X utf8=0`` explicitly disables :ref:`Python UTF-8 Mode <utf8-mode>`
(even when it would otherwise activate automatically).
+ See also :envvar:`PYTHONUTF8`.
* ``-X pycache_prefix=PATH`` enables writing ``.pyc`` files to a parallel
tree rooted at the given directory instead of to the code tree. See also
:envvar:`PYTHONPYCACHEPREFIX`.
@@ -861,7 +864,9 @@ conflict.
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.
+ frame.
+ See the :func:`tracemalloc.start` function for more information.
+ This is equivalent to setting the :option:`-X` ``tracemalloc`` option.
.. versionadded:: 3.4
@@ -869,8 +874,8 @@ conflict.
.. envvar:: PYTHONPROFILEIMPORTTIME
If this environment variable is set to a non-empty string, Python will
- show how long each import takes. This is exactly equivalent to setting
- ``-X importtime`` on the command line.
+ show how long each import takes.
+ This is equivalent to setting the :option:`-X` ``importtime`` option.
.. versionadded:: 3.7
@@ -1012,6 +1017,7 @@ conflict.
If this environment variable is set to a non-empty string, enable
:ref:`Python Development Mode <devmode>`, introducing additional runtime
checks that are too expensive to be enabled by default.
+ This is equivalent to setting the :option:`-X` ``dev`` option.
.. versionadded:: 3.7