gh-90300: split --help output into separate options by merwok · Pull Request #30331 · python/cpython · GitHub

gh-90300: Make --help output shorter and add new help options.

--help-env, --help-xoptions and --help-all command-line options are
added to complement --help.

I thought showing all help options on their own line could be nice.

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

Thanks for working on this! I left some comments and suggestions.

Turns out that showing the invalid value in this error message is not trivial: real C programmers had issue with it too before #28823

--help-xoptions is listed a few items below, but if scanning the list it might be helpful to explicitly mention it here. (Sorry if it's been suggested before & declined!).

Suggested change

      
            -X opt : set implementation-specific option\n\
          
            -X opt : set implementation-specific option (see --help-xoptions)\n\

I’ve added it and removed it. In the current version, I think it is not needed, as it is a few lines later and in the man page and shown in error message for unknown X option, but have no problem adding it if someone adds 👍🏽 to your comment 🙂

This is ready and complete for me. I did not change all lines to be <80 columns like Serhiy requested, but the upside is that the diff size is very reasonable. I would like to merge this week-end, or sooner if there are approving reviews, then create the backport PR for 3.11.

🤖 New build scheduled with the buildbot fleet by @merwok for commit 5485255 🤖

If you want to schedule another build, you need to add the ":hammer: test-with-buildbots" label again.

Thanks @merwok for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

…0331) Make --help output shorter and add new help options. --help-env, --help-xoptions and --help-all command-line options are added to complement --help. (cherry picked from commit 8aa9d40) Co-authored-by: Éric <earaujo@caravan.coop>

GH-93413 is a backport of this pull request to the 3.11 branch.

🎉 Thanks for seeing this through, @merwok! It's a nice improvement. 😄

Make --help output shorter and add new help options. --help-env, --help-xoptions and --help-all command-line options are added to complement --help. (cherry picked from commit 8aa9d40) Co-authored-by: Éric <earaujo@caravan.coop>

move list of X options out of help output

225c869

the-knights-who-say-ni added the CLA signed label Jan 2, 2022

bedevere-bot added the awaiting core review label Jan 2, 2022

merwok commented Jan 2, 2022

View reviewed changes

Comment thread Python/initconfig.c Outdated

merwok commented Jan 2, 2022

View reviewed changes

Comment thread Python/initconfig.c

mention help option in fatal error message

eaefd1a

merwok commented Jan 2, 2022

View reviewed changes

Comment thread Python/initconfig.c Outdated

move variable declaration out of case block

57fd33b

merwok commented Jan 2, 2022

View reviewed changes

Comment thread Python/initconfig.c Outdated

move extra envvars help to separate option

55dbf69

merwok marked this pull request as ready for review January 2, 2022 23:16

merwok requested review from ericsnowcurrently, pablogsal, serhiy-storchaka and vstinner January 2, 2022 23:16

merwok changed the title bpo-46142: make python --help output shorter [WIP] bpo-46142: split --help output into separate options Jan 2, 2022

Éric Araujo added 2 commits January 2, 2022 18:22

doc

0aaf9af

add minimal tests

a592003

merwok commented Jan 2, 2022

View reviewed changes

Comment thread Lib/test/test_cmd_line.py Outdated

merwok commented Jan 2, 2022

View reviewed changes

Comment thread Misc/python.man

merwok commented Jan 2, 2022

View reviewed changes

Comment thread Python/initconfig.c Outdated

merwok commented Jan 2, 2022

View reviewed changes

Comment thread Python/initconfig.c Outdated

flatten the sub-switch

1c4cf63

merwok requested a review from warsaw January 3, 2022 15:28

warsaw requested changes Jan 3, 2022

View reviewed changes

bedevere-bot added awaiting changes and removed awaiting core review labels Jan 3, 2022

merwok linked an issue May 25, 2022 that may be closed by this pull request

python --help output is too long #90300

Closed

fix formatting issues and missing info in man page and --help

24526bd

merwok mentioned this pull request May 25, 2022

python --help output is too long #90300

Closed

make new tests a bit more useful

0bb5dfa

ericsnowcurrently reviewed May 25, 2022

View reviewed changes

Comment thread Python/initconfig.c Outdated

512 bytes should be enough for everyone

8fa72f5

merwok commented May 26, 2022

View reviewed changes

Éric Araujo added 4 commits May 26, 2022 12:34

keep long option at the end of help text

29d04a0

merge branch 'fix-help-man'

356d1bf

fix tests and output

ac1b5fb

final fixes

9bcea95

merwok requested review from ericsnowcurrently and serhiy-storchaka May 26, 2022 14:29

merge upstream

5485255

AA-Turner reviewed May 29, 2022

View reviewed changes

merwok added needs backport to 3.11 only security fixes 🔨 test-with-buildbots Test PR w/ buildbots; report in status section labels May 31, 2022

bedevere-bot removed the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label May 31, 2022

serhiy-storchaka approved these changes Jun 1, 2022

View reviewed changes

merwok merged commit 8aa9d40 into python:main Jun 1, 2022

bedevere-bot removed the awaiting merge label Jun 1, 2022

merwok deleted the shorten-help-output branch June 1, 2022 09:50

bedevere-bot removed the needs backport to 3.11 only security fixes label Jun 1, 2022

-                          when the interpreter displays tracebacks.\n\
-                       -X frozen_modules=[on|off]: whether or not frozen modules should be used.\n\
-                          The default is \"on\" (or \"off\" if you are running a local build).\n\
+              -X opt : set implementation-specific option\n\

+              ]
+              [
+              .B \-X help
+              ]

                   if (option != NULL) {
-                      return PyStatus_Error("Unknown value for option -X");
+                      return PyStatus_Error("Unknown value for option -X (see --help-xoptions)");
                   }

	-X opt : set implementation-specific option\n\
	-X opt : set implementation-specific option (see --help-xoptions)\n\

gh-90300: split --help output into separate options by merwok · Pull Request #30331 · python/cpython · GitHub

Repository navigation

gh-90300: split --help output into separate options - #30331

gh-90300: split --help output into separate options#30331merwok merged 33 commits intopython:mainpython/cpython:mainfrom merwok:shorten-help-outputmerwok/cpython:shorten-help-outputCopy head branch name to clipboard

Conversation

merwok commented Jan 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

merwok Jan 2, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bedevere-bot commented Jan 3, 2022

Uh oh!

warsaw commented Jan 3, 2022

Uh oh!

Uh oh!

merwok May 26, 2022

Choose a reason for hiding this comment

Uh oh!

AA-Turner May 29, 2022

Choose a reason for hiding this comment

Uh oh!

merwok May 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

merwok commented May 31, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bedevere-bot commented May 31, 2022

Uh oh!

miss-islington commented Jun 1, 2022

Uh oh!

bedevere-bot commented Jun 1, 2022

Uh oh!

ericsnowcurrently commented Jun 2, 2022

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

gh-90300: split --help output into separate options#30331
merwok merged 33 commits into
python:mainfrom
merwok:shorten-help-output

merwok commented Jan 2, 2022 •
edited
Loading

merwok May 30, 2022 •
edited
Loading

merwok commented May 31, 2022 •
edited
Loading