FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

bpo-17232: Clarify docs for -O and -OO command line options by csabella · Pull Request #5839 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

bpo-17232: Clarify docs for -O and -OO command line options - #5839

Merged
terryjreedy merged 2 commits into
python:masterfrom
csabella:bpo17232
Feb 25, 2018
ConversationCommits (2)ChecksFiles changed
Merged

bpo-17232: Clarify docs for -O and -OO command line options#5839
terryjreedy merged 2 commits into
python:masterfrom
csabella:bpo17232

Conversation

csabella commented Feb 23, 2018 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Contributor

Original patch by Terry Reedy.

https://bugs.python.org/issue17232

vadmium reviewed Feb 24, 2018
View reviewed changes
Comment thread Modules/main.c Outdated
-OO : remove doc-strings in addition to the -O optimizations\n\
-O : remove assert and __debug__-dependent statements; add .opt1 before\n\
.pyc extension; also PYTHONOPTIMIZE=x\n\
-OO : do -O changes and also discard docstrings; add .opt2 before\n\

vadmium Feb 24, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Why do these say “.opt1” etc without a dash, but the other cases have a dash in “.opt-1” etc?

terryjreedy Feb 24, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I presume oversight on Cheryl's part. I will fix.

terryjreedy Feb 24, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I presume oversight. I checked my cache and '-' is correct.

csabella Feb 24, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Yes, thank you for noticing that, Martin, and thank you, Terry, for fixing it. It was an oversight.

terryjreedy approved these changes Feb 24, 2018
View reviewed changes

terryjreedy left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks for moving this along. I will edit and test locally.
Approve was a click mistake.

Comment thread Modules/main.c Outdated
-OO : remove doc-strings in addition to the -O optimizations\n\
-O : remove assert and __debug__-dependent statements; add .opt1 before\n\
.pyc extension; also PYTHONOPTIMIZE=x\n\
-OO : do -O changes and also discard docstrings; add .opt2 before\n\

terryjreedy Feb 24, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I presume oversight on Cheryl's part. I will fix.

Comment thread Doc/using/cmdline.rst Outdated
Turn on basic optimizations. See also :envvar:`PYTHONOPTIMIZE`.
Remove assert statements and any code conditional on the value of
:const:`__debug__`. Change the filename extension for compiled
(:term:`bytecode`) files to include ``.opt-1`` before the ``.pyc``

terryjreedy Feb 24, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I will change these to read 'Augment the filename for compiled bytecode files by adding .opt-1 before the .pyc extension. ' It does not matter whether one thinks of the addition as a 2nd extension or not, and the change is strictly an addition.

Comment thread Modules/main.c Outdated
-OO : remove doc-strings in addition to the -O optimizations\n\
-O : remove assert and __debug__-dependent statements; add .opt1 before\n\
.pyc extension; also PYTHONOPTIMIZE=x\n\
-OO : do -O changes and also discard docstrings; add .opt2 before\n\

terryjreedy Feb 24, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I presume oversight. I checked my cache and '-' is correct.

terryjreedy reviewed Feb 24, 2018
View reviewed changes
Comment thread Misc/python.man
.TP
.B \-OO
Discard docstrings in addition to the \fB-O\fP optimizations.
Do \fB-O\fP and also discard docstrings; change the filename for

terryjreedy Feb 24, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Cheryl, can you explain the \fB, \fP markup and verify that you somehow tested that it does 'the right thing'? I looked at both the web page and python -h output.

csabella Feb 24, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

When I changed the line, I kept that part from the original line and simply add the other text around it. However, it appears the Github does attempt to show what will happen with it. If you click on the 'View' button for this source, Github applies the markup in non-raw mode. This shows up as bolded as does some of the text in the -i and -I option that has similar (though not exactly the same) markup.

terryjreedy Feb 25, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks. Enough to comfortably merge without personal test.

terryjreedy merged commit 186b606 into python:master Feb 25, 2018

bedevere-bot commented Feb 25, 2018

Copy link
Copy Markdown

@terryjreedy: Please replace # with GH- in the commit message next time. Thanks!

miss-islington commented Feb 25, 2018

Copy link
Copy Markdown
Contributor

Thanks @csabella for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.6, 3.7.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 25, 2018
bpo-17232: Clarify docs for -O and -OO command line options (pythonGH…
03af7ce 
…-5839)

The 'optimization' is for space in the executable file, not for run time.
(cherry picked from commit 186b606)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>

bedevere-bot commented Feb 25, 2018

Copy link
Copy Markdown

GH-5867 is a backport of this pull request to the 3.7 branch.

bedevere-bot commented Feb 25, 2018

Copy link
Copy Markdown

GH-5868 is a backport of this pull request to the 3.6 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 25, 2018
bpo-17232: Clarify docs for -O and -OO command line options (pythonGH…
4f20ee0 
…-5839)

The 'optimization' is for space in the executable file, not for run time.
(cherry picked from commit 186b606)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
miss-islington added a commit that referenced this pull request Feb 25, 2018
bpo-17232: Clarify docs for -O and -OO command line options (GH-5839)
b5655f3 
The 'optimization' is for space in the executable file, not for run time.
(cherry picked from commit 186b606)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
miss-islington added a commit that referenced this pull request Feb 25, 2018
bpo-17232: Clarify docs for -O and -OO command line options (GH-5839)
fc9471a 
The 'optimization' is for space in the executable file, not for run time.
(cherry picked from commit 186b606)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
csabella deleted the bpo17232 branch February 25, 2018 09:59
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

vadmium vadmium left review comments
terryjreedy terryjreedy approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

Back | FazBrowse Home | New Git URL