diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2018-02-24 19:24:08 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-02-24 19:24:08 -0800 |
commit | b5655f3d187084579ff389dbd8734742a8b66cbc (patch) | |
tree | de44aff3af2d01836b3629b5184532b14ec8c362 /Doc/using | |
parent | 01d9c23e470d708b922a1085347404000e985c0f (diff) | |
download | cpython-git-b5655f3d187084579ff389dbd8734742a8b66cbc.tar.gz |
bpo-17232: Clarify docs for -O and -OO command line options (GH-5839)
The 'optimization' is for space in the executable file, not for run time.
(cherry picked from commit 186b606d8a2ea4fd51b7286813302c8e8c7006cc)
Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
Diffstat (limited to 'Doc/using')
-rw-r--r-- | Doc/using/cmdline.rst | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst index 1e9ed6e645..21ba0b5ceb 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -260,12 +260,23 @@ Miscellaneous options .. cmdoption:: -O - Turn on basic optimizations. See also :envvar:`PYTHONOPTIMIZE`. + Remove assert statements and any code conditional on the value of + :const:`__debug__`. Augment the filename for compiled + (:term:`bytecode`) files by adding ``.opt-1`` before the ``.pyc`` + extension (see :pep:`488`). See also :envvar:`PYTHONOPTIMIZE`. + + .. versionchanged:: 3.5 + Modify ``.pyc`` filenames according to :pep:`488`. .. cmdoption:: -OO - Discard docstrings in addition to the :option:`-O` optimizations. + Do :option:`-O` and also discard docstrings. Augment the filename + for compiled (:term:`bytecode`) files by adding ``.opt-2`` before the + ``.pyc`` extension (see :pep:`488`). + + .. versionchanged:: 3.5 + Modify ``.pyc`` filenames according to :pep:`488`. .. cmdoption:: -q |