[3.12] gh-90300: Sort the -X options and some envvars in the Python CLI help (GH-116739) (GH-116766)

(cherry picked from commit e54bdeab9c)
This commit is contained in:
Serhiy Storchaka 2024-03-14 01:02:29 +02:00 committed by GitHub
parent 0cc504771f
commit 870cd901ea
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -78,19 +78,6 @@ arg ...: arguments passed to program in sys.argv[1:]\n\
static const char usage_xoptions[] = "\ static const char usage_xoptions[] = "\
The following implementation-specific options are available:\n\ The following implementation-specific options are available:\n\
-X faulthandler: enable faulthandler\n\
-X showrefcount: output the total reference count and number of used\n\
memory blocks when the program finishes or after each statement in\n\
the interactive interpreter. This only works on debug builds\n\
-X tracemalloc: start tracing Python memory allocations using the\n\
tracemalloc module. By default, only the most recent frame is stored\n\
in a traceback of a trace. Use -X tracemalloc=NFRAME to start\n\
tracing with a traceback limit of NFRAME frames\n\
-X importtime: show how long each import takes. It shows module name,\n\
cumulative time (including nested imports) and self time (excluding\n\
nested imports). Note that its output may be broken in\n\
multi-threaded application.\n\
Typical usage is python3 -X importtime -c 'import asyncio'\n\
-X dev : enable CPython's \"development mode\", introducing additional runtime\n\ -X dev : enable CPython's \"development mode\", introducing additional runtime\n\
checks which are too expensive to be enabled by default. Effect of\n\ checks which are too expensive to be enabled by default. Effect of\n\
the developer mode:\n\ the developer mode:\n\
@ -102,12 +89,18 @@ The following implementation-specific options are available:\n\
* Enable asyncio debug mode\n\ * Enable asyncio debug mode\n\
* Set the dev_mode attribute of sys.flags to True\n\ * Set the dev_mode attribute of sys.flags to True\n\
* io.IOBase destructor logs close() exceptions\n\ * io.IOBase destructor logs close() exceptions\n\
-X utf8: enable UTF-8 mode for operating system interfaces, overriding the\n\ -X faulthandler: enable faulthandler\n\
default locale-aware mode. -X utf8=0 explicitly disables UTF-8 mode\n\ -X frozen_modules=[on|off]: whether or not frozen modules should be used.\n\
(even when it would otherwise activate automatically)\n\ The default is \"on\" (or \"off\" if you are running a local build).\n\
-X pycache_prefix=PATH: enable writing .pyc files to a parallel tree rooted\n\ -X importtime: show how long each import takes. It shows module name,\n\
at the given directory instead of to the code tree\n\ cumulative time (including nested imports) and self time (excluding\n\
-X warn_default_encoding: enable opt-in EncodingWarning for 'encoding=None'\n\ nested imports). Note that its output may be broken in\n\
multi-threaded application.\n\
Typical usage is python3 -X importtime -c 'import asyncio'\n\
-X int_max_str_digits=number: limit the size of int<->str conversions.\n\
This helps avoid denial of service attacks when parsing untrusted\n\
data. The default is sys.int_info.default_max_str_digits.\n\
0 disables.\n\
-X no_debug_ranges: disable the inclusion of the tables mapping extra location\n\ -X no_debug_ranges: disable the inclusion of the tables mapping extra location\n\
information (end line, start column offset and end column offset) to\n\ information (end line, start column offset and end column offset) to\n\
every instruction in code objects. This is useful when smaller code\n\ every instruction in code objects. This is useful when smaller code\n\
@ -118,17 +111,25 @@ The following implementation-specific options are available:\n\
profiler will be able to report Python calls. This option is only\n\ profiler will be able to report Python calls. This option is only\n\
available on some platforms and will do nothing if is not supported\n\ available on some platforms and will do nothing if is not supported\n\
on the current system. The default value is \"off\".\n\ on the current system. The default value is \"off\".\n\
-X frozen_modules=[on|off]: whether or not frozen modules should be used.\n\ -X pycache_prefix=PATH: enable writing .pyc files to a parallel tree rooted\n\
The default is \"on\" (or \"off\" if you are running a local build).\n\ at the given directory instead of to the code tree\n\
-X int_max_str_digits=number: limit the size of int<->str conversions.\n\
This helps avoid denial of service attacks when parsing untrusted\n\
data. The default is sys.int_info.default_max_str_digits.\n\
0 disables.\
" "
#ifdef Py_STATS #ifdef Py_STATS
"\n\ "-X pystats: Enable pystats collection at startup.\n"
-X pystats: Enable pystats collection at startup."
#endif #endif
"\
-X showrefcount: output the total reference count and number of used\n\
memory blocks when the program finishes or after each statement in\n\
the interactive interpreter. This only works on debug builds\n\
-X tracemalloc: start tracing Python memory allocations using the\n\
tracemalloc module. By default, only the most recent frame is stored\n\
in a traceback of a trace. Use -X tracemalloc=NFRAME to start\n\
tracing with a traceback limit of NFRAME frames\n\
-X utf8: enable UTF-8 mode for operating system interfaces, overriding the\n\
default locale-aware mode. -X utf8=0 explicitly disables UTF-8 mode\n\
(even when it would otherwise activate automatically)\n\
-X warn_default_encoding: enable opt-in EncodingWarning for 'encoding=None'\
"
; ;
/* Envvars that don't have equivalent command-line options are listed first */ /* Envvars that don't have equivalent command-line options are listed first */