mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-21 17:25:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

[3.12] Docs: Avoid the deprecated `.. cmdoption::` directive (GH-110292) (#110302)

Browse source 
[3.12] Docs: Avoid the deprecated ``.. cmdoption::`` directive (GH-110292).
(cherry picked from commit 77e9aae383)
This commit is contained in:
Adam Turner 2023-10-03 18:55:29 +01:00 • committed by GitHub
parent 90dea557bb
commit 4c0f42bbc6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
18 changed files with 203 additions and 203 deletions
Download patch file Download diff file Expand all files Collapse all files

14
Doc/library/ast.rst
View file

@ -2477,26 +2477,26 @@ The following options are accepted:
.. program:: ast .. program:: ast
.. cmdoption:: -h, --help .. option:: -h, --help
Show the help message and exit. Show the help message and exit.
.. cmdoption:: -m <mode> .. option:: -m <mode>
--mode <mode> --mode <mode>
Specify what kind of code must be compiled, like the *mode* argument Specify what kind of code must be compiled, like the *mode* argument
in :func:`parse`. in :func:`parse`.
.. cmdoption:: --no-type-comments .. option:: --no-type-comments
Don't parse type comments. Don't parse type comments.
.. cmdoption:: -a, --include-attributes .. option:: -a, --include-attributes
Include attributes such as line numbers and column offsets. Include attributes such as line numbers and column offsets.
.. cmdoption:: -i <indent> .. option:: -i <indent>
--indent <indent> --indent <indent>
Indentation of nodes in AST (number of spaces). Indentation of nodes in AST (number of spaces).

34
Doc/library/compileall.rst
View file

@ -24,28 +24,28 @@ compile Python sources.
.. program:: compileall .. program:: compileall
.. cmdoption:: directory ... .. option:: directory ...
file ... file ...
Positional arguments are files to compile or directories that contain Positional arguments are files to compile or directories that contain
source files, traversed recursively. If no argument is given, behave as if source files, traversed recursively. If no argument is given, behave as if
the command line was :samp:`-l {<directories from sys.path>}`. the command line was :samp:`-l {<directories from sys.path>}`.
.. cmdoption:: -l .. option:: -l
Do not recurse into subdirectories, only compile source code files directly Do not recurse into subdirectories, only compile source code files directly
contained in the named or implied directories. contained in the named or implied directories.
.. cmdoption:: -f .. option:: -f
Force rebuild even if timestamps are up-to-date. Force rebuild even if timestamps are up-to-date.
.. cmdoption:: -q .. option:: -q
Do not print the list of files compiled. If passed once, error messages will Do not print the list of files compiled. If passed once, error messages will
still be printed. If passed twice (``-qq``), all output is suppressed. still be printed. If passed twice (``-qq``), all output is suppressed.
.. cmdoption:: -d destdir .. option:: -d destdir
Directory prepended to the path to each file being compiled. This will Directory prepended to the path to each file being compiled. This will
appear in compilation time tracebacks, and is also compiled in to the appear in compilation time tracebacks, and is also compiled in to the
@ -53,45 +53,45 @@ compile Python sources.
cases where the source file does not exist at the time the byte-code file is cases where the source file does not exist at the time the byte-code file is
executed. executed.
.. cmdoption:: -s strip_prefix .. option:: -s strip_prefix
.. cmdoption:: -p prepend_prefix .. option:: -p prepend_prefix
Remove (``-s``) or append (``-p``) the given prefix of paths Remove (``-s``) or append (``-p``) the given prefix of paths
recorded in the ``.pyc`` files. recorded in the ``.pyc`` files.
Cannot be combined with ``-d``. Cannot be combined with ``-d``.
.. cmdoption:: -x regex .. option:: -x regex
regex is used to search the full path to each file considered for regex is used to search the full path to each file considered for
compilation, and if the regex produces a match, the file is skipped. compilation, and if the regex produces a match, the file is skipped.
.. cmdoption:: -i list .. option:: -i list
Read the file ``list`` and add each line that it contains to the list of Read the file ``list`` and add each line that it contains to the list of
files and directories to compile. If ``list`` is ``-``, read lines from files and directories to compile. If ``list`` is ``-``, read lines from
``stdin``. ``stdin``.
.. cmdoption:: -b .. option:: -b
Write the byte-code files to their legacy locations and names, which may Write the byte-code files to their legacy locations and names, which may
overwrite byte-code files created by another version of Python. The default overwrite byte-code files created by another version of Python. The default
is to write files to their :pep:`3147` locations and names, which allows is to write files to their :pep:`3147` locations and names, which allows
byte-code files from multiple versions of Python to coexist. byte-code files from multiple versions of Python to coexist.
.. cmdoption:: -r .. option:: -r
Control the maximum recursion level for subdirectories. Control the maximum recursion level for subdirectories.
If this is given, then ``-l`` option will not be taken into account. If this is given, then ``-l`` option will not be taken into account.
:program:`python -m compileall <directory> -r 0` is equivalent to :program:`python -m compileall <directory> -r 0` is equivalent to
:program:`python -m compileall <directory> -l`. :program:`python -m compileall <directory> -l`.
.. cmdoption:: -j N .. option:: -j N
Use *N* workers to compile the files within the given directory. Use *N* workers to compile the files within the given directory.
If ``0`` is used, then the result of :func:`os.cpu_count()` If ``0`` is used, then the result of :func:`os.cpu_count()`
will be used. will be used.
.. cmdoption:: --invalidation-mode [timestamp|checked-hash|unchecked-hash] .. option:: --invalidation-mode [timestamp|checked-hash|unchecked-hash]
Control how the generated byte-code files are invalidated at runtime. Control how the generated byte-code files are invalidated at runtime.
The ``timestamp`` value, means that ``.pyc`` files with the source timestamp The ``timestamp`` value, means that ``.pyc`` files with the source timestamp
@ -104,17 +104,17 @@ compile Python sources.
variable is not set, and ``checked-hash`` if the ``SOURCE_DATE_EPOCH`` variable is not set, and ``checked-hash`` if the ``SOURCE_DATE_EPOCH``
environment variable is set. environment variable is set.
.. cmdoption:: -o level .. option:: -o level
Compile with the given optimization level. May be used multiple times Compile with the given optimization level. May be used multiple times
to compile for multiple levels at a time (for example, to compile for multiple levels at a time (for example,
``compileall -o 1 -o 2``). ``compileall -o 1 -o 2``).
.. cmdoption:: -e dir .. option:: -e dir
Ignore symlinks pointing outside the given directory. Ignore symlinks pointing outside the given directory.
.. cmdoption:: --hardlink-dupes .. option:: --hardlink-dupes
If two ``.pyc`` files with different optimization level have If two ``.pyc`` files with different optimization level have
the same content, use hard links to consolidate duplicate files. the same content, use hard links to consolidate duplicate files.

10
Doc/library/gzip.rst
View file

@ -266,23 +266,23 @@ Once executed the :mod:`gzip` module keeps the input file(s).
Command line options Command line options
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
.. cmdoption:: file .. option:: file
If *file* is not specified, read from :data:`sys.stdin`. If *file* is not specified, read from :data:`sys.stdin`.
.. cmdoption:: --fast .. option:: --fast
Indicates the fastest compression method (less compression). Indicates the fastest compression method (less compression).
.. cmdoption:: --best .. option:: --best
Indicates the slowest compression method (best compression). Indicates the slowest compression method (best compression).
.. cmdoption:: -d, --decompress .. option:: -d, --decompress
Decompress the given file. Decompress the given file.
.. cmdoption:: -h, --help .. option:: -h, --help
Show the help message. Show the help message.

2
Doc/library/inspect.rst
View file

@ -1650,6 +1650,6 @@ By default, accepts the name of a module and prints the source of that
module. A class or function within the module can be printed instead by module. A class or function within the module can be printed instead by
appended a colon and the qualified name of the target object. appended a colon and the qualified name of the target object.
.. cmdoption:: --details .. option:: --details
Print information about the specified object rather than the source code Print information about the specified object rather than the source code

14
Doc/library/json.rst
View file

@ -703,7 +703,7 @@ specified, :data:`sys.stdin` and :data:`sys.stdout` will be used respectively:
Command line options Command line options
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
.. cmdoption:: infile .. option:: infile
The JSON file to be validated or pretty-printed: The JSON file to be validated or pretty-printed:
@ -723,36 +723,36 @@ Command line options
If *infile* is not specified, read from :data:`sys.stdin`. If *infile* is not specified, read from :data:`sys.stdin`.
.. cmdoption:: outfile .. option:: outfile
Write the output of the *infile* to the given *outfile*. Otherwise, write it Write the output of the *infile* to the given *outfile*. Otherwise, write it
to :data:`sys.stdout`. to :data:`sys.stdout`.
.. cmdoption:: --sort-keys .. option:: --sort-keys
Sort the output of dictionaries alphabetically by key. Sort the output of dictionaries alphabetically by key.
.. versionadded:: 3.5 .. versionadded:: 3.5
.. cmdoption:: --no-ensure-ascii .. option:: --no-ensure-ascii
Disable escaping of non-ascii characters, see :func:`json.dumps` for more information. Disable escaping of non-ascii characters, see :func:`json.dumps` for more information.
.. versionadded:: 3.9 .. versionadded:: 3.9
.. cmdoption:: --json-lines .. option:: --json-lines
Parse every input line as separate JSON object. Parse every input line as separate JSON object.
.. versionadded:: 3.8 .. versionadded:: 3.8
.. cmdoption:: --indent, --tab, --no-indent, --compact .. option:: --indent, --tab, --no-indent, --compact
Mutually exclusive options for whitespace control. Mutually exclusive options for whitespace control.
.. versionadded:: 3.9 .. versionadded:: 3.9
.. cmdoption:: -h, --help .. option:: -h, --help
Show the help message. Show the help message.

10
Doc/library/pickletools.rst
View file

@ -51,24 +51,24 @@ Command line options
.. program:: pickletools .. program:: pickletools
.. cmdoption:: -a, --annotate .. option:: -a, --annotate
Annotate each line with a short opcode description. Annotate each line with a short opcode description.
.. cmdoption:: -o, --output=<file> .. option:: -o, --output=<file>
Name of a file where the output should be written. Name of a file where the output should be written.
.. cmdoption:: -l, --indentlevel=<num> .. option:: -l, --indentlevel=<num>
The number of blanks by which to indent a new MARK level. The number of blanks by which to indent a new MARK level.
.. cmdoption:: -m, --memo .. option:: -m, --memo
When multiple objects are disassembled, preserve memo between When multiple objects are disassembled, preserve memo between
disassemblies. disassemblies.
.. cmdoption:: -p, --preamble=<preamble> .. option:: -p, --preamble=<preamble>
When more than one pickle file are specified, print given preamble When more than one pickle file are specified, print given preamble
before each disassembly. before each disassembly.

6
Doc/library/py_compile.rst
View file

@ -138,13 +138,13 @@ not be compiled.
.. program:: python -m py_compile .. program:: python -m py_compile
.. cmdoption:: <file> ... <fileN> .. option:: <file> ... <fileN>
- -
Positional arguments are files to compile. If ``-`` is the only Positional arguments are files to compile. If ``-`` is the only
parameter, the list of files is taken from standard input. parameter, the list of files is taken from standard input.
.. cmdoption:: -q, --quiet .. option:: -q, --quiet
Suppress errors output. Suppress errors output.

4
Doc/library/site.rst
View file

@ -266,11 +266,11 @@ If it is called without arguments, it will print the contents of
:data:`USER_BASE` and whether the directory exists, then the same thing for :data:`USER_BASE` and whether the directory exists, then the same thing for
:data:`USER_SITE`, and finally the value of :data:`ENABLE_USER_SITE`. :data:`USER_SITE`, and finally the value of :data:`ENABLE_USER_SITE`.
.. cmdoption:: --user-base .. option:: --user-base
Print the path to the user base directory. Print the path to the user base directory.
.. cmdoption:: --user-site .. option:: --user-site
Print the path to the user site-packages directory. Print the path to the user site-packages directory.

20
Doc/library/tarfile.rst
View file

@ -1151,31 +1151,31 @@ For a list of the files in a tar archive, use the :option:`-l` option:
Command-line options Command-line options
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
.. cmdoption:: -l <tarfile> .. option:: -l <tarfile>
--list <tarfile> --list <tarfile>
List files in a tarfile. List files in a tarfile.
.. cmdoption:: -c <tarfile> <source1> ... <sourceN> .. option:: -c <tarfile> <source1> ... <sourceN>
--create <tarfile> <source1> ... <sourceN> --create <tarfile> <source1> ... <sourceN>
Create tarfile from source files. Create tarfile from source files.
.. cmdoption:: -e <tarfile> [<output_dir>] .. option:: -e <tarfile> [<output_dir>]
--extract <tarfile> [<output_dir>] --extract <tarfile> [<output_dir>]
Extract tarfile into the current directory if *output_dir* is not specified. Extract tarfile into the current directory if *output_dir* is not specified.
.. cmdoption:: -t <tarfile> .. option:: -t <tarfile>
--test <tarfile> --test <tarfile>
Test whether the tarfile is valid or not. Test whether the tarfile is valid or not.
.. cmdoption:: -v, --verbose .. option:: -v, --verbose
Verbose output. Verbose output.
.. cmdoption:: --filter <filtername> .. option:: --filter <filtername>
Specifies the *filter* for ``--extract``. Specifies the *filter* for ``--extract``.
See :ref:`tarfile-extraction-filter` for details. See :ref:`tarfile-extraction-filter` for details.

14
Doc/library/timeit.rst
View file

@ -214,36 +214,36 @@ Where the following options are understood:
.. program:: timeit .. program:: timeit
.. cmdoption:: -n N, --number=N .. option:: -n N, --number=N
how many times to execute 'statement' how many times to execute 'statement'
.. cmdoption:: -r N, --repeat=N .. option:: -r N, --repeat=N
how many times to repeat the timer (default 5) how many times to repeat the timer (default 5)
.. cmdoption:: -s S, --setup=S .. option:: -s S, --setup=S
statement to be executed once initially (default ``pass``) statement to be executed once initially (default ``pass``)
.. cmdoption:: -p, --process .. option:: -p, --process
measure process time, not wallclock time, using :func:`time.process_time` measure process time, not wallclock time, using :func:`time.process_time`
instead of :func:`time.perf_counter`, which is the default instead of :func:`time.perf_counter`, which is the default
.. versionadded:: 3.3 .. versionadded:: 3.3
.. cmdoption:: -u, --unit=U .. option:: -u, --unit=U
specify a time unit for timer output; can select ``nsec``, ``usec``, ``msec``, or ``sec`` specify a time unit for timer output; can select ``nsec``, ``usec``, ``msec``, or ``sec``
.. versionadded:: 3.5 .. versionadded:: 3.5
.. cmdoption:: -v, --verbose .. option:: -v, --verbose
print raw timing results; repeat for more digits precision print raw timing results; repeat for more digits precision
.. cmdoption:: -h, --help .. option:: -h, --help
print a short usage message and exit print a short usage message and exit

4
Doc/library/tokenize.rst
View file

@ -166,11 +166,11 @@ The following options are accepted:
.. program:: tokenize .. program:: tokenize
.. cmdoption:: -h, --help .. option:: -h, --help
show this help message and exit show this help message and exit
.. cmdoption:: -e, --exact .. option:: -e, --exact
display token names using the exact type display token names using the exact type

30
Doc/library/trace.rst
View file

@ -34,11 +34,11 @@ all Python modules imported during the execution into the current directory.
.. program:: trace .. program:: trace
.. cmdoption:: --help .. option:: --help
Display usage and exit. Display usage and exit.
.. cmdoption:: --version .. option:: --version
Display the version of the module and exit. Display the version of the module and exit.
@ -56,28 +56,28 @@ the :option:`--trace <-t>` and :option:`--count <-c>` options. When
.. program:: trace .. program:: trace
.. cmdoption:: -c, --count .. option:: -c, --count
Produce a set of annotated listing files upon program completion that shows Produce a set of annotated listing files upon program completion that shows
how many times each statement was executed. See also how many times each statement was executed. See also
:option:`--coverdir <-C>`, :option:`--file <-f>` and :option:`--coverdir <-C>`, :option:`--file <-f>` and
:option:`--no-report <-R>` below. :option:`--no-report <-R>` below.
.. cmdoption:: -t, --trace .. option:: -t, --trace
Display lines as they are executed. Display lines as they are executed.
.. cmdoption:: -l, --listfuncs .. option:: -l, --listfuncs
Display the functions executed by running the program. Display the functions executed by running the program.
.. cmdoption:: -r, --report .. option:: -r, --report
Produce an annotated list from an earlier program run that used the Produce an annotated list from an earlier program run that used the
:option:`--count <-c>` and :option:`--file <-f>` option. This does not :option:`--count <-c>` and :option:`--file <-f>` option. This does not
execute any code. execute any code.
.. cmdoption:: -T, --trackcalls .. option:: -T, --trackcalls
Display the calling relationships exposed by running the program. Display the calling relationships exposed by running the program.
@ -86,33 +86,33 @@ Modifiers
.. program:: trace .. program:: trace
.. cmdoption:: -f, --file=<file> .. option:: -f, --file=<file>
Name of a file to accumulate counts over several tracing runs. Should be Name of a file to accumulate counts over several tracing runs. Should be
used with the :option:`--count <-c>` option. used with the :option:`--count <-c>` option.
.. cmdoption:: -C, --coverdir=<dir> .. option:: -C, --coverdir=<dir>
Directory where the report files go. The coverage report for Directory where the report files go. The coverage report for
``package.module`` is written to file :file:`{dir}/{package}/{module}.cover`. ``package.module`` is written to file :file:`{dir}/{package}/{module}.cover`.
.. cmdoption:: -m, --missing .. option:: -m, --missing
When generating annotated listings, mark lines which were not executed with When generating annotated listings, mark lines which were not executed with
``>>>>>>``. ``>>>>>>``.
.. cmdoption:: -s, --summary .. option:: -s, --summary
When using :option:`--count <-c>` or :option:`--report <-r>`, write a brief When using :option:`--count <-c>` or :option:`--report <-r>`, write a brief
summary to stdout for each file processed. summary to stdout for each file processed.
.. cmdoption:: -R, --no-report .. option:: -R, --no-report
Do not generate annotated listings. This is useful if you intend to make Do not generate annotated listings. This is useful if you intend to make
several runs with :option:`--count <-c>`, and then produce a single set of several runs with :option:`--count <-c>`, and then produce a single set of
annotated listings at the end. annotated listings at the end.
.. cmdoption:: -g, --timing .. option:: -g, --timing
Prefix each line with the time since the program started. Only used while Prefix each line with the time since the program started. Only used while
tracing. tracing.
@ -124,12 +124,12 @@ These options may be repeated multiple times.
.. program:: trace .. program:: trace
.. cmdoption:: --ignore-module=<mod> .. option:: --ignore-module=<mod>
Ignore each of the given module names and its submodules (if it is a Ignore each of the given module names and its submodules (if it is a
package). The argument can be a list of names separated by a comma. package). The argument can be a list of names separated by a comma.
.. cmdoption:: --ignore-dir=<dir> .. option:: --ignore-dir=<dir>
Ignore all modules and packages in the named directory and subdirectories. Ignore all modules and packages in the named directory and subdirectories.
The argument can be a list of directories separated by :data:`os.pathsep`. The argument can be a list of directories separated by :data:`os.pathsep`.

20
Doc/library/unittest.rst
View file

@ -206,13 +206,13 @@ Command-line options
.. program:: unittest .. program:: unittest
.. cmdoption:: -b, --buffer .. option:: -b, --buffer
The standard output and standard error streams are buffered during the test The standard output and standard error streams are buffered during the test
run. Output during a passing test is discarded. Output is echoed normally run. Output during a passing test is discarded. Output is echoed normally
on test fail or error and is added to the failure messages. on test fail or error and is added to the failure messages.
.. cmdoption:: -c, --catch .. option:: -c, --catch
:kbd:`Control-C` during the test run waits for the current test to end and then :kbd:`Control-C` during the test run waits for the current test to end and then
reports all the results so far. A second :kbd:`Control-C` raises the normal reports all the results so far. A second :kbd:`Control-C` raises the normal
@ -220,11 +220,11 @@ Command-line options
See `Signal Handling`_ for the functions that provide this functionality. See `Signal Handling`_ for the functions that provide this functionality.
.. cmdoption:: -f, --failfast .. option:: -f, --failfast
Stop the test run on the first error or failure. Stop the test run on the first error or failure.
.. cmdoption:: -k .. option:: -k
Only run test methods and classes that match the pattern or substring. Only run test methods and classes that match the pattern or substring.
This option may be used multiple times, in which case all test cases that This option may be used multiple times, in which case all test cases that
@ -240,11 +240,11 @@ Command-line options
For example, ``-k foo`` matches ``foo_tests.SomeTest.test_something``, For example, ``-k foo`` matches ``foo_tests.SomeTest.test_something``,
``bar_tests.SomeTest.test_foo``, but not ``bar_tests.FooTest.test_something``. ``bar_tests.SomeTest.test_foo``, but not ``bar_tests.FooTest.test_something``.
.. cmdoption:: --locals .. option:: --locals
Show local variables in tracebacks. Show local variables in tracebacks.
.. cmdoption:: --durations N .. option:: --durations N
Show the N slowest test cases (N=0 for all). Show the N slowest test cases (N=0 for all).
@ -292,19 +292,19 @@ The ``discover`` sub-command has the following options:
.. program:: unittest discover .. program:: unittest discover
.. cmdoption:: -v, --verbose .. option:: -v, --verbose
Verbose output Verbose output
.. cmdoption:: -s, --start-directory directory .. option:: -s, --start-directory directory
Directory to start discovery (``.`` default) Directory to start discovery (``.`` default)
.. cmdoption:: -p, --pattern pattern .. option:: -p, --pattern pattern
Pattern to match test files (``test*.py`` default) Pattern to match test files (``test*.py`` default)
.. cmdoption:: -t, --top-level-directory directory .. option:: -t, --top-level-directory directory
Top level directory of project (defaults to start directory) Top level directory of project (defaults to start directory)

14
Doc/library/uuid.rst
View file

@ -289,25 +289,25 @@ The following options are accepted:
.. program:: uuid .. program:: uuid
.. cmdoption:: -h, --help .. option:: -h, --help
Show the help message and exit. Show the help message and exit.
.. cmdoption:: -u <uuid> .. option:: -u <uuid>
--uuid <uuid> --uuid <uuid>
Specify the function name to use to generate the uuid. By default :func:`uuid4` Specify the function name to use to generate the uuid. By default :func:`uuid4`
is used. is used.
.. cmdoption:: -n <namespace> .. option:: -n <namespace>
--namespace <namespace> --namespace <namespace>
The namespace is a ``UUID``, or ``@ns`` where ``ns`` is a well-known predefined UUID The namespace is a ``UUID``, or ``@ns`` where ``ns`` is a well-known predefined UUID
addressed by namespace name. Such as ``@dns``, ``@url``, ``@oid``, and ``@x500``. addressed by namespace name. Such as ``@dns``, ``@url``, ``@oid``, and ``@x500``.
Only required for :func:`uuid3` / :func:`uuid5` functions. Only required for :func:`uuid3` / :func:`uuid5` functions.
.. cmdoption:: -N <name> .. option:: -N <name>
--name <name> --name <name>
The name used as part of generating the uuid. Only required for The name used as part of generating the uuid. Only required for
:func:`uuid3` / :func:`uuid5` functions. :func:`uuid3` / :func:`uuid5` functions.

12
Doc/library/zipapp.rst
View file

@ -54,7 +54,7 @@ The following options are understood:
.. program:: zipapp .. program:: zipapp
.. cmdoption:: -o <output>, --output=<output> .. option:: -o <output>, --output=<output>
Write the output to a file named *output*. If this option is not specified, Write the output to a file named *output*. If this option is not specified,
the output filename will be the same as the input *source*, with the the output filename will be the same as the input *source*, with the
@ -64,13 +64,13 @@ The following options are understood:
An output filename must be specified if the *source* is an archive (and in An output filename must be specified if the *source* is an archive (and in
that case, *output* must not be the same as *source*). that case, *output* must not be the same as *source*).
.. cmdoption:: -p <interpreter>, --python=<interpreter> .. option:: -p <interpreter>, --python=<interpreter>
Add a ``#!`` line to the archive specifying *interpreter* as the command Add a ``#!`` line to the archive specifying *interpreter* as the command
to run. Also, on POSIX, make the archive executable. The default is to to run. Also, on POSIX, make the archive executable. The default is to
write no ``#!`` line, and not make the file executable. write no ``#!`` line, and not make the file executable.
.. cmdoption:: -m <mainfn>, --main=<mainfn> .. option:: -m <mainfn>, --main=<mainfn>
Write a ``__main__.py`` file to the archive that executes *mainfn*. The Write a ``__main__.py`` file to the archive that executes *mainfn*. The
*mainfn* argument should have the form "pkg.mod:fn", where "pkg.mod" is a *mainfn* argument should have the form "pkg.mod:fn", where "pkg.mod" is a
@ -79,7 +79,7 @@ The following options are understood:
:option:`--main` cannot be specified when copying an archive. :option:`--main` cannot be specified when copying an archive.
.. cmdoption:: -c, --compress .. option:: -c, --compress
Compress files with the deflate method, reducing the size of the output Compress files with the deflate method, reducing the size of the output
file. By default, files are stored uncompressed in the archive. file. By default, files are stored uncompressed in the archive.
@ -88,13 +88,13 @@ The following options are understood:
.. versionadded:: 3.7 .. versionadded:: 3.7
.. cmdoption:: --info .. option:: --info
Display the interpreter embedded in the archive, for diagnostic purposes. In Display the interpreter embedded in the archive, for diagnostic purposes. In
this case, any other options are ignored and SOURCE must be an archive, not a this case, any other options are ignored and SOURCE must be an archive, not a
directory. directory.
.. cmdoption:: -h, --help .. option:: -h, --help
Print a short usage message and exit. Print a short usage message and exit.

18
Doc/library/zipfile.rst
View file

@ -905,27 +905,27 @@ For a list of the files in a ZIP archive, use the :option:`-l` option:
Command-line options Command-line options
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
.. cmdoption:: -l <zipfile> .. option:: -l <zipfile>
--list <zipfile> --list <zipfile>
List files in a zipfile. List files in a zipfile.
.. cmdoption:: -c <zipfile> <source1> ... <sourceN> .. option:: -c <zipfile> <source1> ... <sourceN>
--create <zipfile> <source1> ... <sourceN> --create <zipfile> <source1> ... <sourceN>
Create zipfile from source files. Create zipfile from source files.
.. cmdoption:: -e <zipfile> <output_dir> .. option:: -e <zipfile> <output_dir>
--extract <zipfile> <output_dir> --extract <zipfile> <output_dir>
Extract zipfile into target directory. Extract zipfile into target directory.
.. cmdoption:: -t <zipfile> .. option:: -t <zipfile>
--test <zipfile> --test <zipfile>
Test whether the zipfile is valid or not. Test whether the zipfile is valid or not.
.. cmdoption:: --metadata-encoding <encoding> .. option:: --metadata-encoding <encoding>
Specify encoding of member names for :option:`-l`, :option:`-e` and Specify encoding of member names for :option:`-l`, :option:`-e` and
:option:`-t`. :option:`-t`.

60
Doc/using/cmdline.rst
View file

@ -59,7 +59,7 @@ all consecutive arguments will end up in :data:`sys.argv` -- note that the first
element, subscript zero (``sys.argv[0]``), is a string reflecting the program's element, subscript zero (``sys.argv[0]``), is a string reflecting the program's
source. source.
.. cmdoption:: -c <command> .. option:: -c <command>
Execute the Python code in *command*. *command* can be one or more Execute the Python code in *command*. *command* can be one or more
statements separated by newlines, with significant leading whitespace as in statements separated by newlines, with significant leading whitespace as in
@ -72,7 +72,7 @@ source.
.. audit-event:: cpython.run_command command cmdoption-c .. audit-event:: cpython.run_command command cmdoption-c
.. cmdoption:: -m <module-name> .. option:: -m <module-name>
Search :data:`sys.path` for the named module and execute its contents as Search :data:`sys.path` for the named module and execute its contents as
the :mod:`__main__` module. the :mod:`__main__` module.
@ -188,35 +188,35 @@ automatically enabled, if available on your platform (see
Generic options Generic options
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
.. cmdoption:: -? .. option:: -?
-h -h
--help --help
Print a short description of all command line options and corresponding Print a short description of all command line options and corresponding
environment variables and exit. environment variables and exit.
.. cmdoption:: --help-env .. option:: --help-env
Print a short description of Python-specific environment variables Print a short description of Python-specific environment variables
and exit. and exit.
.. versionadded:: 3.11 .. versionadded:: 3.11
.. cmdoption:: --help-xoptions .. option:: --help-xoptions
Print a description of implementation-specific :option:`-X` options Print a description of implementation-specific :option:`-X` options
and exit. and exit.
.. versionadded:: 3.11 .. versionadded:: 3.11
.. cmdoption:: --help-all .. option:: --help-all
Print complete usage information and exit. Print complete usage information and exit.
.. versionadded:: 3.11 .. versionadded:: 3.11
.. cmdoption:: -V .. option:: -V
--version --version
Print the Python version number and exit. Example output could be: Print the Python version number and exit. Example output could be:
@ -240,7 +240,7 @@ Generic options
Miscellaneous options Miscellaneous options
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
.. cmdoption:: -b .. option:: -b
Issue a warning when comparing :class:`bytes` or :class:`bytearray` with Issue a warning when comparing :class:`bytes` or :class:`bytearray` with
:class:`str` or :class:`bytes` with :class:`int`. Issue an error when the :class:`str` or :class:`bytes` with :class:`int`. Issue an error when the
@ -249,13 +249,13 @@ Miscellaneous options
.. versionchanged:: 3.5 .. versionchanged:: 3.5
Affects comparisons of :class:`bytes` with :class:`int`. Affects comparisons of :class:`bytes` with :class:`int`.
.. cmdoption:: -B .. option:: -B
If given, Python won't try to write ``.pyc`` files on the If given, Python won't try to write ``.pyc`` files on the
import of source modules. See also :envvar:`PYTHONDONTWRITEBYTECODE`. import of source modules. See also :envvar:`PYTHONDONTWRITEBYTECODE`.
.. cmdoption:: --check-hash-based-pycs default|always|never .. option:: --check-hash-based-pycs default|always|never
Control the validation behavior of hash-based ``.pyc`` files. See Control the validation behavior of hash-based ``.pyc`` files. See
:ref:`pyc-invalidation`. When set to ``default``, checked and unchecked :ref:`pyc-invalidation`. When set to ``default``, checked and unchecked
@ -269,7 +269,7 @@ Miscellaneous options
option. option.
.. cmdoption:: -d .. option:: -d
Turn on parser debugging output (for expert only). Turn on parser debugging output (for expert only).
See also the :envvar:`PYTHONDEBUG` environment variable. See also the :envvar:`PYTHONDEBUG` environment variable.
@ -278,7 +278,7 @@ Miscellaneous options
it's ignored. it's ignored.
.. cmdoption:: -E .. option:: -E
Ignore all :envvar:`PYTHON*` environment variables, e.g. Ignore all :envvar:`PYTHON*` environment variables, e.g.
:envvar:`PYTHONPATH` and :envvar:`PYTHONHOME`, that might be set. :envvar:`PYTHONPATH` and :envvar:`PYTHONHOME`, that might be set.
@ -286,7 +286,7 @@ Miscellaneous options
See also the :option:`-P` and :option:`-I` (isolated) options. See also the :option:`-P` and :option:`-I` (isolated) options.
.. cmdoption:: -i .. option:: -i
When a script is passed as first argument or the :option:`-c` option is used, When a script is passed as first argument or the :option:`-c` option is used,
enter interactive mode after executing the script or the command, even when enter interactive mode after executing the script or the command, even when
@ -297,7 +297,7 @@ Miscellaneous options
raises an exception. See also :envvar:`PYTHONINSPECT`. raises an exception. See also :envvar:`PYTHONINSPECT`.
.. cmdoption:: -I .. option:: -I
Run Python in isolated mode. This also implies :option:`-E`, :option:`-P` Run Python in isolated mode. This also implies :option:`-E`, :option:`-P`
and :option:`-s` options. and :option:`-s` options.
@ -310,7 +310,7 @@ Miscellaneous options
.. versionadded:: 3.4 .. versionadded:: 3.4
.. cmdoption:: -O .. option:: -O
Remove assert statements and any code conditional on the value of Remove assert statements and any code conditional on the value of
:const:`__debug__`. Augment the filename for compiled :const:`__debug__`. Augment the filename for compiled
@ -321,7 +321,7 @@ Miscellaneous options
Modify ``.pyc`` filenames according to :pep:`488`. Modify ``.pyc`` filenames according to :pep:`488`.
.. cmdoption:: -OO .. option:: -OO
Do :option:`-O` and also discard docstrings. Augment the filename Do :option:`-O` and also discard docstrings. Augment the filename
for compiled (:term:`bytecode`) files by adding ``.opt-2`` before the for compiled (:term:`bytecode`) files by adding ``.opt-2`` before the
@ -331,7 +331,7 @@ Miscellaneous options
Modify ``.pyc`` filenames according to :pep:`488`. Modify ``.pyc`` filenames according to :pep:`488`.
.. cmdoption:: -P .. option:: -P
Don't prepend a potentially unsafe path to :data:`sys.path`: Don't prepend a potentially unsafe path to :data:`sys.path`:
@ -348,14 +348,14 @@ Miscellaneous options
.. versionadded:: 3.11 .. versionadded:: 3.11
.. cmdoption:: -q .. option:: -q
Don't display the copyright and version messages even in interactive mode. Don't display the copyright and version messages even in interactive mode.
.. versionadded:: 3.2 .. versionadded:: 3.2
.. cmdoption:: -R .. option:: -R
Turn on hash randomization. This option only has an effect if the Turn on hash randomization. This option only has an effect if the
:envvar:`PYTHONHASHSEED` environment variable is set to ``0``, since hash :envvar:`PYTHONHASHSEED` environment variable is set to ``0``, since hash
@ -381,7 +381,7 @@ Miscellaneous options
.. versionadded:: 3.2.3 .. versionadded:: 3.2.3
.. cmdoption:: -s .. option:: -s
Don't add the :data:`user site-packages directory <site.USER_SITE>` to Don't add the :data:`user site-packages directory <site.USER_SITE>` to
:data:`sys.path`. :data:`sys.path`.
@ -391,7 +391,7 @@ Miscellaneous options
:pep:`370` -- Per user site-packages directory :pep:`370` -- Per user site-packages directory
.. cmdoption:: -S .. option:: -S
Disable the import of the module :mod:`site` and the site-dependent Disable the import of the module :mod:`site` and the site-dependent
manipulations of :data:`sys.path` that it entails. Also disable these manipulations of :data:`sys.path` that it entails. Also disable these
@ -399,7 +399,7 @@ Miscellaneous options
:func:`site.main` if you want them to be triggered). :func:`site.main` if you want them to be triggered).
.. cmdoption:: -u .. option:: -u
Force the stdout and stderr streams to be unbuffered. This option has no Force the stdout and stderr streams to be unbuffered. This option has no
effect on the stdin stream. effect on the stdin stream.
@ -410,7 +410,7 @@ Miscellaneous options
The text layer of the stdout and stderr streams now is unbuffered. The text layer of the stdout and stderr streams now is unbuffered.
.. cmdoption:: -v .. option:: -v
Print a message each time a module is initialized, showing the place Print a message each time a module is initialized, showing the place
(filename or built-in module) from which it is loaded. When given twice (filename or built-in module) from which it is loaded. When given twice
@ -425,7 +425,7 @@ Miscellaneous options
.. _using-on-warnings: .. _using-on-warnings:
.. cmdoption:: -W arg .. option:: -W arg
Warning control. Python's warning machinery by default prints warning Warning control. Python's warning machinery by default prints warning
messages to :data:`sys.stderr`. messages to :data:`sys.stderr`.
@ -484,13 +484,13 @@ Miscellaneous options
details. details.
.. cmdoption:: -x .. option:: -x
Skip the first line of the source, allowing use of non-Unix forms of Skip the first line of the source, allowing use of non-Unix forms of
``#!cmd``. This is intended for a DOS specific hack only. ``#!cmd``. This is intended for a DOS specific hack only.
.. cmdoption:: -X .. option:: -X
Reserved for various implementation-specific options. CPython currently Reserved for various implementation-specific options. CPython currently
defines the following possible values: defines the following possible values:
@ -597,7 +597,7 @@ Miscellaneous options
Options you shouldn't use Options you shouldn't use
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
.. cmdoption:: -J .. option:: -J
Reserved for use by Jython_. Reserved for use by Jython_.

120
Doc/using/configure.rst
View file

@ -80,7 +80,7 @@ See also the :file:`Misc/SpecialBuilds.txt` in the Python source distribution.
General Options General Options
--------------- ---------------
.. cmdoption:: --enable-loadable-sqlite-extensions .. option:: --enable-loadable-sqlite-extensions
Support loadable extensions in the :mod:`!_sqlite` extension module (default Support loadable extensions in the :mod:`!_sqlite` extension module (default
is no) of the :mod:`sqlite3` module. is no) of the :mod:`sqlite3` module.
@ -90,12 +90,12 @@ General Options
.. versionadded:: 3.6 .. versionadded:: 3.6
.. cmdoption:: --disable-ipv6 .. option:: --disable-ipv6
Disable IPv6 support (enabled by default if supported), see the Disable IPv6 support (enabled by default if supported), see the
:mod:`socket` module. :mod:`socket` module.
.. cmdoption:: --enable-big-digits=[15|30] .. option:: --enable-big-digits=[15|30]
Define the size in bits of Python :class:`int` digits: 15 or 30 bits. Define the size in bits of Python :class:`int` digits: 15 or 30 bits.
@ -105,7 +105,7 @@ General Options
See :data:`sys.int_info.bits_per_digit <sys.int_info>`. See :data:`sys.int_info.bits_per_digit <sys.int_info>`.
.. cmdoption:: --with-suffix=SUFFIX .. option:: --with-suffix=SUFFIX
Set the Python executable suffix to *SUFFIX*. Set the Python executable suffix to *SUFFIX*.
@ -118,7 +118,7 @@ General Options
The default suffix on WASM platform is one of ``.js``, ``.html`` The default suffix on WASM platform is one of ``.js``, ``.html``
or ``.wasm``. or ``.wasm``.
.. cmdoption:: --with-tzpath=<list of absolute paths separated by pathsep> .. option:: --with-tzpath=<list of absolute paths separated by pathsep>
Select the default time zone search path for :const:`zoneinfo.TZPATH`. Select the default time zone search path for :const:`zoneinfo.TZPATH`.
See the :ref:`Compile-time configuration See the :ref:`Compile-time configuration
@ -130,7 +130,7 @@ General Options
.. versionadded:: 3.9 .. versionadded:: 3.9
.. cmdoption:: --without-decimal-contextvar .. option:: --without-decimal-contextvar
Build the ``_decimal`` extension module using a thread-local context rather Build the ``_decimal`` extension module using a thread-local context rather
than a coroutine-local context (default), see the :mod:`decimal` module. than a coroutine-local context (default), see the :mod:`decimal` module.
@ -139,7 +139,7 @@ General Options
.. versionadded:: 3.9 .. versionadded:: 3.9
.. cmdoption:: --with-dbmliborder=<list of backend names> .. option:: --with-dbmliborder=<list of backend names>
Override order to check db backends for the :mod:`dbm` module Override order to check db backends for the :mod:`dbm` module
@ -149,7 +149,7 @@ General Options
* ``gdbm``; * ``gdbm``;
* ``bdb``. * ``bdb``.
.. cmdoption:: --without-c-locale-coercion .. option:: --without-c-locale-coercion
Disable C locale coercion to a UTF-8 based locale (enabled by default). Disable C locale coercion to a UTF-8 based locale (enabled by default).
@ -157,13 +157,13 @@ General Options
See :envvar:`PYTHONCOERCECLOCALE` and the :pep:`538`. See :envvar:`PYTHONCOERCECLOCALE` and the :pep:`538`.
.. cmdoption:: --without-freelists .. option:: --without-freelists
Disable all freelists except the empty tuple singleton. Disable all freelists except the empty tuple singleton.
.. versionadded:: 3.11 .. versionadded:: 3.11
.. cmdoption:: --with-platlibdir=DIRNAME .. option:: --with-platlibdir=DIRNAME
Python library directory name (default is ``lib``). Python library directory name (default is ``lib``).
@ -173,7 +173,7 @@ General Options
.. versionadded:: 3.9 .. versionadded:: 3.9
.. cmdoption:: --with-wheel-pkg-dir=PATH .. option:: --with-wheel-pkg-dir=PATH
Directory of wheel packages used by the :mod:`ensurepip` module Directory of wheel packages used by the :mod:`ensurepip` module
(none by default). (none by default).
@ -185,7 +185,7 @@ General Options
.. versionadded:: 3.10 .. versionadded:: 3.10
.. cmdoption:: --with-pkg-config=[check|yes|no] .. option:: --with-pkg-config=[check|yes|no]
Whether configure should use :program:`pkg-config` to detect build Whether configure should use :program:`pkg-config` to detect build
dependencies. dependencies.
@ -196,7 +196,7 @@ General Options
.. versionadded:: 3.11 .. versionadded:: 3.11
.. cmdoption:: --enable-pystats .. option:: --enable-pystats
Turn on internal statistics gathering. Turn on internal statistics gathering.
@ -211,7 +211,7 @@ General Options
WebAssembly Options WebAssembly Options
------------------- -------------------
.. cmdoption:: --with-emscripten-target=[browser|node] .. option:: --with-emscripten-target=[browser|node]
Set build flavor for ``wasm32-emscripten``. Set build flavor for ``wasm32-emscripten``.
@ -220,7 +220,7 @@ WebAssembly Options
.. versionadded:: 3.11 .. versionadded:: 3.11
.. cmdoption:: --enable-wasm-dynamic-linking .. option:: --enable-wasm-dynamic-linking
Turn on dynamic linking support for WASM. Turn on dynamic linking support for WASM.
@ -229,7 +229,7 @@ WebAssembly Options
.. versionadded:: 3.11 .. versionadded:: 3.11
.. cmdoption:: --enable-wasm-pthreads .. option:: --enable-wasm-pthreads
Turn on pthreads support for WASM. Turn on pthreads support for WASM.
@ -239,7 +239,7 @@ WebAssembly Options
Install Options Install Options
--------------- ---------------
.. cmdoption:: --prefix=PREFIX .. option:: --prefix=PREFIX
Install architecture-independent files in PREFIX. On Unix, it Install architecture-independent files in PREFIX. On Unix, it
defaults to :file:`/usr/local`. defaults to :file:`/usr/local`.
@ -249,20 +249,20 @@ Install Options
As an example, one can use ``--prefix="$HOME/.local/"`` to install As an example, one can use ``--prefix="$HOME/.local/"`` to install
a Python in its home directory. a Python in its home directory.
.. cmdoption:: --exec-prefix=EPREFIX .. option:: --exec-prefix=EPREFIX
Install architecture-dependent files in EPREFIX, defaults to :option:`--prefix`. Install architecture-dependent files in EPREFIX, defaults to :option:`--prefix`.
This value can be retrieved at runtime using :data:`sys.exec_prefix`. This value can be retrieved at runtime using :data:`sys.exec_prefix`.
.. cmdoption:: --disable-test-modules .. option:: --disable-test-modules
Don't build nor install test modules, like the :mod:`test` package or the Don't build nor install test modules, like the :mod:`test` package or the
:mod:`!_testcapi` extension module (built and installed by default). :mod:`!_testcapi` extension module (built and installed by default).
.. versionadded:: 3.10 .. versionadded:: 3.10
.. cmdoption:: --with-ensurepip=[upgrade|install|no] .. option:: --with-ensurepip=[upgrade|install|no]
Select the :mod:`ensurepip` command run on Python installation: Select the :mod:`ensurepip` command run on Python installation:
@ -281,7 +281,7 @@ Configuring Python using ``--enable-optimizations --with-lto`` (PGO + LTO) is
recommended for best performance. The experimental ``--enable-bolt`` flag can recommended for best performance. The experimental ``--enable-bolt`` flag can
also be used to improve performance. also be used to improve performance.
.. cmdoption:: --enable-optimizations .. option:: --enable-optimizations
Enable Profile Guided Optimization (PGO) using :envvar:`PROFILE_TASK` Enable Profile Guided Optimization (PGO) using :envvar:`PROFILE_TASK`
(disabled by default). (disabled by default).
@ -307,7 +307,7 @@ also be used to improve performance.
.. versionadded:: 3.8 .. versionadded:: 3.8
.. cmdoption:: --with-lto=[full|thin|no|yes] .. option:: --with-lto=[full|thin|no|yes]
Enable Link Time Optimization (LTO) in any build (disabled by default). Enable Link Time Optimization (LTO) in any build (disabled by default).
@ -322,7 +322,7 @@ also be used to improve performance.
.. versionchanged:: 3.12 .. versionchanged:: 3.12
Use ThinLTO as the default optimization policy on Clang if the compiler accepts the flag. Use ThinLTO as the default optimization policy on Clang if the compiler accepts the flag.
.. cmdoption:: --enable-bolt .. option:: --enable-bolt
Enable usage of the `BOLT post-link binary optimizer Enable usage of the `BOLT post-link binary optimizer
<https://github.com/llvm/llvm-project/tree/main/bolt>`_ (disabled by <https://github.com/llvm/llvm-project/tree/main/bolt>`_ (disabled by
@ -347,19 +347,19 @@ also be used to improve performance.
.. versionadded:: 3.12 .. versionadded:: 3.12
.. cmdoption:: --with-computed-gotos .. option:: --with-computed-gotos
Enable computed gotos in evaluation loop (enabled by default on supported Enable computed gotos in evaluation loop (enabled by default on supported
compilers). compilers).
.. cmdoption:: --without-pymalloc .. option:: --without-pymalloc
Disable the specialized Python memory allocator :ref:`pymalloc <pymalloc>` Disable the specialized Python memory allocator :ref:`pymalloc <pymalloc>`
(enabled by default). (enabled by default).
See also :envvar:`PYTHONMALLOC` environment variable. See also :envvar:`PYTHONMALLOC` environment variable.
.. cmdoption:: --without-doc-strings .. option:: --without-doc-strings
Disable static documentation strings to reduce the memory footprint (enabled Disable static documentation strings to reduce the memory footprint (enabled
by default). Documentation strings defined in Python are not affected. by default). Documentation strings defined in Python are not affected.
@ -368,11 +368,11 @@ also be used to improve performance.
See the ``PyDoc_STRVAR()`` macro. See the ``PyDoc_STRVAR()`` macro.
.. cmdoption:: --enable-profiling .. option:: --enable-profiling
Enable C-level code profiling with ``gprof`` (disabled by default). Enable C-level code profiling with ``gprof`` (disabled by default).
.. cmdoption:: --with-strict-overflow .. option:: --with-strict-overflow
Add ``-fstrict-overflow`` to the C compiler flags (by default we add Add ``-fstrict-overflow`` to the C compiler flags (by default we add
``-fno-strict-overflow`` instead). ``-fno-strict-overflow`` instead).
@ -429,12 +429,12 @@ See also the :ref:`Python Development Mode <devmode>` and the
Debug options Debug options
------------- -------------
.. cmdoption:: --with-pydebug .. option:: --with-pydebug
:ref:`Build Python in debug mode <debug-build>`: define the ``Py_DEBUG`` :ref:`Build Python in debug mode <debug-build>`: define the ``Py_DEBUG``
macro (disabled by default). macro (disabled by default).
.. cmdoption:: --with-trace-refs .. option:: --with-trace-refs
Enable tracing references for debugging purpose (disabled by default). Enable tracing references for debugging purpose (disabled by default).
@ -449,7 +449,7 @@ Debug options
.. versionadded:: 3.8 .. versionadded:: 3.8
.. cmdoption:: --with-assertions .. option:: --with-assertions
Build with C assertions enabled (default is no): ``assert(...);`` and Build with C assertions enabled (default is no): ``assert(...);`` and
``_PyObject_ASSERT(...);``. ``_PyObject_ASSERT(...);``.
@ -462,11 +462,11 @@ Debug options
.. versionadded:: 3.6 .. versionadded:: 3.6
.. cmdoption:: --with-valgrind .. option:: --with-valgrind
Enable Valgrind support (default is no). Enable Valgrind support (default is no).
.. cmdoption:: --with-dtrace .. option:: --with-dtrace
Enable DTrace support (default is no). Enable DTrace support (default is no).
@ -475,19 +475,19 @@ Debug options
.. versionadded:: 3.6 .. versionadded:: 3.6
.. cmdoption:: --with-address-sanitizer .. option:: --with-address-sanitizer
Enable AddressSanitizer memory error detector, ``asan`` (default is no). Enable AddressSanitizer memory error detector, ``asan`` (default is no).
.. versionadded:: 3.6 .. versionadded:: 3.6
.. cmdoption:: --with-memory-sanitizer .. option:: --with-memory-sanitizer
Enable MemorySanitizer allocation error detector, ``msan`` (default is no). Enable MemorySanitizer allocation error detector, ``msan`` (default is no).
.. versionadded:: 3.6 .. versionadded:: 3.6
.. cmdoption:: --with-undefined-behavior-sanitizer .. option:: --with-undefined-behavior-sanitizer
Enable UndefinedBehaviorSanitizer undefined behaviour detector, ``ubsan`` Enable UndefinedBehaviorSanitizer undefined behaviour detector, ``ubsan``
(default is no). (default is no).
@ -498,11 +498,11 @@ Debug options
Linker options Linker options
-------------- --------------
.. cmdoption:: --enable-shared .. option:: --enable-shared
Enable building a shared Python library: ``libpython`` (default is no). Enable building a shared Python library: ``libpython`` (default is no).
.. cmdoption:: --without-static-libpython .. option:: --without-static-libpython
Do not build ``libpythonMAJOR.MINOR.a`` and do not install ``python.o`` Do not build ``libpythonMAJOR.MINOR.a`` and do not install ``python.o``
(built and enabled by default). (built and enabled by default).
@ -513,23 +513,23 @@ Linker options
Libraries options Libraries options
----------------- -----------------
.. cmdoption:: --with-libs='lib1 ...' .. option:: --with-libs='lib1 ...'
Link against additional libraries (default is no). Link against additional libraries (default is no).
.. cmdoption:: --with-system-expat .. option:: --with-system-expat
Build the :mod:`!pyexpat` module using an installed ``expat`` library Build the :mod:`!pyexpat` module using an installed ``expat`` library
(default is no). (default is no).
.. cmdoption:: --with-system-libmpdec .. option:: --with-system-libmpdec
Build the ``_decimal`` extension module using an installed ``mpdec`` Build the ``_decimal`` extension module using an installed ``mpdec``
library, see the :mod:`decimal` module (default is no). library, see the :mod:`decimal` module (default is no).
.. versionadded:: 3.3 .. versionadded:: 3.3
.. cmdoption:: --with-readline=editline .. option:: --with-readline=editline
Use ``editline`` library for backend of the :mod:`readline` module. Use ``editline`` library for backend of the :mod:`readline` module.
@ -537,7 +537,7 @@ Libraries options
.. versionadded:: 3.10 .. versionadded:: 3.10
.. cmdoption:: --without-readline .. option:: --without-readline
Don't build the :mod:`readline` module (built by default). Don't build the :mod:`readline` module (built by default).
@ -545,21 +545,21 @@ Libraries options
.. versionadded:: 3.10 .. versionadded:: 3.10
.. cmdoption:: --with-libm=STRING .. option:: --with-libm=STRING
Override ``libm`` math library to *STRING* (default is system-dependent). Override ``libm`` math library to *STRING* (default is system-dependent).
.. cmdoption:: --with-libc=STRING .. option:: --with-libc=STRING
Override ``libc`` C library to *STRING* (default is system-dependent). Override ``libc`` C library to *STRING* (default is system-dependent).
.. cmdoption:: --with-openssl=DIR .. option:: --with-openssl=DIR
Root of the OpenSSL directory. Root of the OpenSSL directory.
.. versionadded:: 3.7 .. versionadded:: 3.7
.. cmdoption:: --with-openssl-rpath=[no|auto|DIR] .. option:: --with-openssl-rpath=[no|auto|DIR]
Set runtime library directory (rpath) for OpenSSL libraries: Set runtime library directory (rpath) for OpenSSL libraries:
@ -574,7 +574,7 @@ Libraries options
Security Options Security Options
---------------- ----------------
.. cmdoption:: --with-hash-algorithm=[fnv|siphash13|siphash24] .. option:: --with-hash-algorithm=[fnv|siphash13|siphash24]
Select hash algorithm for use in ``Python/pyhash.c``: Select hash algorithm for use in ``Python/pyhash.c``:
@ -587,7 +587,7 @@ Security Options
.. versionadded:: 3.11 .. versionadded:: 3.11
``siphash13`` is added and it is the new default. ``siphash13`` is added and it is the new default.
.. cmdoption:: --with-builtin-hashlib-hashes=md5,sha1,sha256,sha512,sha3,blake2 .. option:: --with-builtin-hashlib-hashes=md5,sha1,sha256,sha512,sha3,blake2
Built-in hash modules: Built-in hash modules:
@ -600,7 +600,7 @@ Security Options
.. versionadded:: 3.9 .. versionadded:: 3.9
.. cmdoption:: --with-ssl-default-suites=[python|openssl|STRING] .. option:: --with-ssl-default-suites=[python|openssl|STRING]
Override the OpenSSL default cipher suites string: Override the OpenSSL default cipher suites string:
@ -622,19 +622,19 @@ macOS Options
See ``Mac/README.rst``. See ``Mac/README.rst``.
.. cmdoption:: --enable-universalsdk .. option:: --enable-universalsdk
.. cmdoption:: --enable-universalsdk=SDKDIR .. option:: --enable-universalsdk=SDKDIR
Create a universal binary build. *SDKDIR* specifies which macOS SDK should Create a universal binary build. *SDKDIR* specifies which macOS SDK should
be used to perform the build (default is no). be used to perform the build (default is no).
.. cmdoption:: --enable-framework .. option:: --enable-framework
.. cmdoption:: --enable-framework=INSTALLDIR .. option:: --enable-framework=INSTALLDIR
Create a Python.framework rather than a traditional Unix install. Optional Create a Python.framework rather than a traditional Unix install. Optional
*INSTALLDIR* specifies the installation path (default is no). *INSTALLDIR* specifies the installation path (default is no).
.. cmdoption:: --with-universal-archs=ARCH .. option:: --with-universal-archs=ARCH
Specify the kind of universal binary that should be created. This option is Specify the kind of universal binary that should be created. This option is
only valid when :option:`--enable-universalsdk` is set. only valid when :option:`--enable-universalsdk` is set.
@ -650,7 +650,7 @@ See ``Mac/README.rst``.
* ``intel-64``; * ``intel-64``;
* ``all``. * ``all``.
.. cmdoption:: --with-framework-name=FRAMEWORK .. option:: --with-framework-name=FRAMEWORK
Specify the name for the python framework on macOS only valid when Specify the name for the python framework on macOS only valid when
:option:`--enable-framework` is set (default: ``Python``). :option:`--enable-framework` is set (default: ``Python``).
@ -664,21 +664,21 @@ for another CPU architecture or platform. Cross compiling requires a Python
interpreter for the build platform. The version of the build Python must match interpreter for the build platform. The version of the build Python must match
the version of the cross compiled host Python. the version of the cross compiled host Python.
.. cmdoption:: --build=BUILD .. option:: --build=BUILD
configure for building on BUILD, usually guessed by :program:`config.guess`. configure for building on BUILD, usually guessed by :program:`config.guess`.
.. cmdoption:: --host=HOST .. option:: --host=HOST
cross-compile to build programs to run on HOST (target platform) cross-compile to build programs to run on HOST (target platform)
.. cmdoption:: --with-build-python=path/to/python .. option:: --with-build-python=path/to/python
path to build ``python`` binary for cross compiling path to build ``python`` binary for cross compiling
.. versionadded:: 3.11 .. versionadded:: 3.11
.. cmdoption:: CONFIG_SITE=file .. option:: CONFIG_SITE=file
An environment variable that points to a file with configure overrides. An environment variable that points to a file with configure overrides.