Skip to content

Commit 870cd90

Browse files
[3.12] gh-90300: Sort the -X options and some envvars in the Python CLI help (GH-116739) (GH-116766)
(cherry picked from commit e54bdea)
1 parent 0cc5047 commit 870cd90

File tree

1 file changed

+28
-27
lines changed

1 file changed

+28
-27
lines changed

Python/initconfig.c

+28-27
Original file line numberDiff line numberDiff line change
@@ -78,19 +78,6 @@ arg ...: arguments passed to program in sys.argv[1:]\n\
7878

7979
static const char usage_xoptions[] = "\
8080
The following implementation-specific options are available:\n\
81-
-X faulthandler: enable faulthandler\n\
82-
-X showrefcount: output the total reference count and number of used\n\
83-
memory blocks when the program finishes or after each statement in\n\
84-
the interactive interpreter. This only works on debug builds\n\
85-
-X tracemalloc: start tracing Python memory allocations using the\n\
86-
tracemalloc module. By default, only the most recent frame is stored\n\
87-
in a traceback of a trace. Use -X tracemalloc=NFRAME to start\n\
88-
tracing with a traceback limit of NFRAME frames\n\
89-
-X importtime: show how long each import takes. It shows module name,\n\
90-
cumulative time (including nested imports) and self time (excluding\n\
91-
nested imports). Note that its output may be broken in\n\
92-
multi-threaded application.\n\
93-
Typical usage is python3 -X importtime -c 'import asyncio'\n\
9481
-X dev : enable CPython's \"development mode\", introducing additional runtime\n\
9582
checks which are too expensive to be enabled by default. Effect of\n\
9683
the developer mode:\n\
@@ -102,12 +89,18 @@ The following implementation-specific options are available:\n\
10289
* Enable asyncio debug mode\n\
10390
* Set the dev_mode attribute of sys.flags to True\n\
10491
* io.IOBase destructor logs close() exceptions\n\
105-
-X utf8: enable UTF-8 mode for operating system interfaces, overriding the\n\
106-
default locale-aware mode. -X utf8=0 explicitly disables UTF-8 mode\n\
107-
(even when it would otherwise activate automatically)\n\
108-
-X pycache_prefix=PATH: enable writing .pyc files to a parallel tree rooted\n\
109-
at the given directory instead of to the code tree\n\
110-
-X warn_default_encoding: enable opt-in EncodingWarning for 'encoding=None'\n\
92+
-X faulthandler: enable faulthandler\n\
93+
-X frozen_modules=[on|off]: whether or not frozen modules should be used.\n\
94+
The default is \"on\" (or \"off\" if you are running a local build).\n\
95+
-X importtime: show how long each import takes. It shows module name,\n\
96+
cumulative time (including nested imports) and self time (excluding\n\
97+
nested imports). Note that its output may be broken in\n\
98+
multi-threaded application.\n\
99+
Typical usage is python3 -X importtime -c 'import asyncio'\n\
100+
-X int_max_str_digits=number: limit the size of int<->str conversions.\n\
101+
This helps avoid denial of service attacks when parsing untrusted\n\
102+
data. The default is sys.int_info.default_max_str_digits.\n\
103+
0 disables.\n\
111104
-X no_debug_ranges: disable the inclusion of the tables mapping extra location\n\
112105
information (end line, start column offset and end column offset) to\n\
113106
every instruction in code objects. This is useful when smaller code\n\
@@ -118,17 +111,25 @@ The following implementation-specific options are available:\n\
118111
profiler will be able to report Python calls. This option is only\n\
119112
available on some platforms and will do nothing if is not supported\n\
120113
on the current system. The default value is \"off\".\n\
121-
-X frozen_modules=[on|off]: whether or not frozen modules should be used.\n\
122-
The default is \"on\" (or \"off\" if you are running a local build).\n\
123-
-X int_max_str_digits=number: limit the size of int<->str conversions.\n\
124-
This helps avoid denial of service attacks when parsing untrusted\n\
125-
data. The default is sys.int_info.default_max_str_digits.\n\
126-
0 disables.\
114+
-X pycache_prefix=PATH: enable writing .pyc files to a parallel tree rooted\n\
115+
at the given directory instead of to the code tree\n\
127116
"
128117
#ifdef Py_STATS
129-
"\n\
130-
-X pystats: Enable pystats collection at startup."
118+
"-X pystats: Enable pystats collection at startup.\n"
131119
#endif
120+
"\
121+
-X showrefcount: output the total reference count and number of used\n\
122+
memory blocks when the program finishes or after each statement in\n\
123+
the interactive interpreter. This only works on debug builds\n\
124+
-X tracemalloc: start tracing Python memory allocations using the\n\
125+
tracemalloc module. By default, only the most recent frame is stored\n\
126+
in a traceback of a trace. Use -X tracemalloc=NFRAME to start\n\
127+
tracing with a traceback limit of NFRAME frames\n\
128+
-X utf8: enable UTF-8 mode for operating system interfaces, overriding the\n\
129+
default locale-aware mode. -X utf8=0 explicitly disables UTF-8 mode\n\
130+
(even when it would otherwise activate automatically)\n\
131+
-X warn_default_encoding: enable opt-in EncodingWarning for 'encoding=None'\
132+
"
132133
;
133134

134135
/* Envvars that don't have equivalent command-line options are listed first */

0 commit comments

Comments
 (0)