Skip to content

/ cpython

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bpo-39427: Document -X opt options in the CLI --help and the man page #18131

Merged
merged 3 commits into from Jan 23, 2020
Merged

bpo-39427: Document -X opt options in the CLI --help and the man page #18131

merged 3 commits into from Jan 23, 2020
+73 −2

Conversation

@pablogsal
Copy link
Member

pablogsal commented Jan 22, 2020 •
edited by miss-islington

https://bugs.python.org/issue39427

Automerge-Triggered-By: @pablogsal
@pablogsal pablogsal requested a review from vstinner Jan 22, 2020
@pablogsal
bpo-39427: Document -X opt options in the CLI --help
Verified
This commit was signed with a verified signature.
pablogsal Pablo Galindo
GPG key ID: FFE87404168BD847 Learn about signing commits
Loading status checks…
e55beb8
@pablogsal pablogsal force-pushed the pablogsal:bpo-39427 branch from 7a7c1d7 to e55beb8 Jan 22, 2020
@pablogsal
Document -X opt also in the man page
Verified
This commit was signed with a verified signature.
pablogsal Pablo Galindo
GPG key ID: FFE87404168BD847 Learn about signing commits
Loading status checks…
ea6569b
@pablogsal pablogsal changed the title bpo-39427: Document -X opt options in the CLI --help bpo-39427: Document -X opt options in the CLI --help and the man page Jan 22, 2020
@pablogsal pablogsal self-assigned this Jan 22, 2020
@vstinner
vstinner reviewed Jan 22, 2020
View changes
Misc/python.man
checks which are too expensive to be enabled by default. It will not be
more verbose than the default if the code is correct: new warnings are
only emitted when an issue is detected. Effect of the developer mode:
* Add default warning filter, as -W default

This comment has been minimized.

Sign in to view
Copy link
@vstinner

vstinner Jan 22, 2020

Member

I'm not sure if the manual page should elaborate on what are the effects of the development mode. It evolved frequently, and sadly it's common to forget to update the manual page.

This comment has been minimized.

Sign in to view
Copy link
@pablogsal

pablogsal Jan 22, 2020

Author Member

I'm not sure if the manual page should elaborate on what are the effects of the development mode. It evolved frequently, and sadly it's common to forget to update the manual page.

I still think is a good idea to have it in the man page but if you feel strongly I can remove it :)
Python/initconfig.c Outdated Show resolved Hide resolved
Python/initconfig.c Outdated Show resolved Hide resolved
Python/initconfig.c Show resolved Hide resolved
@pablogsal
Adress Victor's feedback
Verified
This commit was signed with a verified signature.
pablogsal Pablo Galindo
GPG key ID: FFE87404168BD847 Learn about signing commits
Loading status checks…
b54fe61
@pablogsal pablogsal force-pushed the pablogsal:bpo-39427 branch from 4c305e9 to b54fe61 Jan 22, 2020
@DinoV

This comment has been minimized.

Sign in to view
Copy link
Contributor

DinoV commented Jan 23, 2020

I was just looking at the help to figure out what these were and had to go look at source code, so i think this looks great. I do wonder if there should eventually be two levels of help but this seems on par w/ having the env vars documented in help.
@DinoV
DinoV approved these changes Jan 23, 2020
View changes
@miss-islington miss-islington merged commit 41f0ef6 into python:master Jan 23, 2020
9 checks passed
9 checks passed
Docs
Details
Windows (x86)
Details
Windows (x64)
Details
macOS
Details
Ubuntu
Details
Azure Pipelines PR #20200122.57 succeeded
Details
bedevere/issue-number Issue number 39427 found
Details
bedevere/news News entry found in Misc/NEWS.d
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@miss-islington

This comment has been minimized.

Sign in to view
Copy link

miss-islington commented Jan 23, 2020

Thanks @pablogsal for the PR 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8.
🐍🍒⛏🤖
@miss-islington

This comment has been minimized.

Sign in to view
Copy link

miss-islington commented Jan 23, 2020

Sorry @pablogsal, I had trouble checking out the 3.8 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 41f0ef6abbd304409c55612a08788cdd59fbc8a3 3.8
@miss-islington

This comment has been minimized.

Sign in to view
Copy link

miss-islington commented Jan 23, 2020

Sorry, @pablogsal, I could not cleanly backport this to 3.7 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 41f0ef6abbd304409c55612a08788cdd59fbc8a3 3.7
@pablogsal pablogsal deleted the pablogsal:bpo-39427 branch Jan 23, 2020
@pablogsal

This comment has been minimized.

Sign in to view
Copy link
Member Author

pablogsal commented Jan 23, 2020

Will backport this tomorrow :)
pablogsal added a commit to pablogsal/cpython that referenced this pull request Jan 23, 2020
@pablogsal
[3.8] bpo-39427: Document -X opt options in the CLI --help and the ma…
Verified
This commit was signed with a verified signature.
pablogsal Pablo Galindo
GPG key ID: FFE87404168BD847 Learn about signing commits
50e4a13 
…n page (pythonGH-18131)

https://bugs.python.org/issue39427

Automerge-Triggered-By: @pablogsal
(cherry picked from commit 41f0ef6)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
@bedevere-bot

This comment has been minimized.

Sign in to view
Copy link

bedevere-bot commented Jan 23, 2020

GH-18133 is a backport of this pull request to the 3.8 branch.
pablogsal added a commit to pablogsal/cpython that referenced this pull request Jan 23, 2020
@pablogsal
[3.7] bpo-39427: Document -X opt options in the CLI --help and the ma…
Verified
This commit was signed with a verified signature.
pablogsal Pablo Galindo
GPG key ID: FFE87404168BD847 Learn about signing commits
fb8c64f 
…n page (pythonGH-18131)

https://bugs.python.org/issue39427

Automerge-Triggered-By: @pablogsal.
(cherry picked from commit 41f0ef6)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
@bedevere-bot

This comment has been minimized.

Sign in to view
Copy link

bedevere-bot commented Jan 23, 2020

GH-18134 is a backport of this pull request to the 3.7 branch.
pablogsal added a commit to pablogsal/cpython that referenced this pull request Jan 23, 2020
@pablogsal
[3.7] bpo-39427: Document -X opt options in the CLI --help and the ma…
Verified
This commit was signed with a verified signature.
pablogsal Pablo Galindo
GPG key ID: FFE87404168BD847 Learn about signing commits
f8ac776 
…n page (pythonGH-18131)

https://bugs.python.org/issue39427

Automerge-Triggered-By: @pablogsal.
(cherry picked from commit 41f0ef6)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vstinner vstinner

@DinoV DinoV

Assignees

@miss-islington miss-islington

Labels
🤖 automerge CLA signed
Projects
None yet
Milestone
No milestone
6 participants
@pablogsal @DinoV @miss-islington @bedevere-bot @vstinner @the-knights-who-say-ni
You can’t perform that action at this time.