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>
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
index 1e9ed6e..21ba0b5 100644
--- a/Doc/using/cmdline.rst
+++ b/Doc/using/cmdline.rst
@@ -260,12 +260,23 @@
.. 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