git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 5/7] help: error if [-a|-g|-c] and [-i|-m|-w] are combined

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Dec 29, 2021, 00:04 UTC
Message-ID
<211229.86v8z8gtt4.gmgdl@evledraar.gmail.com>
In-Reply-To
<CAPig+cSVLPiGUAiK8tt1dp3BVLAwXCAeMvM9LenBUY4s_xBQ+A@mail.gmail.com>
On Tue, Dec 28 2021, Eric Sunshine wrote:
Show 29 quoted lines
> On Tue, Dec 28, 2021 at 10:36 AM Ævar Arnfjörð Bjarmason
> <avarab@gmail.com> wrote:
>> Add more sanity checking to "git help" usage by erroring out if these
>> man viewer options are combined with incompatible command-modes that
>> will never use these documentation viewers.
>>
>> This continues the work started in d35d03cf93e (help: simplify by
>> moving to OPT_CMDMODE(), 2021-09-22) of adding more sanity checking to
>> "git help". Doing this allows us to clarify the "SYNOPSIS" in the
>> documentation, and the "git help -h" output.
>>
>> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
>> ---
>> diff --git a/builtin/help.c b/builtin/help.c
>> @@ -581,6 +581,13 @@ static void no_extra_argc(int argc)
>> +static void no_format(void)
>> +{
>> +       if (help_format != HELP_FORMAT_NONE)
>> +               usage_msg_opt(_("[-a|--all] cannot be combined with [[-i|--info] [-m|--man] [-w|--web]]"),
>> +                             builtin_help_usage, builtin_help_options);
>> +}
>
> Nit: The square brackets in the message may be unnecessarily
> confusing. (Indeed, what exactly do they mean in this context?) Also,
> the short options may not add much value: the user who typed `-w`
> knows presumably that it is shorthand for `--web`. So, one
> simplification would be:
>
>     '--all' cannot be combined with '--info', '--man', or '--web'
Thanks, will change it.
Previous: Eric SunshineNext: Ævar Arnfjörð Bjarmason
Message 8 of 29 in “help: test and fix small "help -g" regression”
  1. 0/7 help: test and fix small "help -g" regressionÆvar Arnfjörð Bjarmason, Dec 28, 2021
  2. 1/7 help doc: add missing "]" to "[-a|--all]"Ævar Arnfjörð Bjarmason, Dec 28, 2021
  3. 2/7 help.c: use puts() instead of printf{,_ln}() for consistencyÆvar Arnfjörð Bjarmason, Dec 28, 2021
  4. 3/7 help tests: test "git" and "git help [-a|-g] spacingÆvar Arnfjörð Bjarmason, Dec 28, 2021
  5. 4/7 help.c: split up list_all_cmds_help() functionÆvar Arnfjörð Bjarmason, Dec 28, 2021
  6. 5/7 help: error if [-a|-g|-c] and [-i|-m|-w] are combinedÆvar Arnfjörð Bjarmason, Dec 28, 2021
  7. Eric SunshineDec 28, 2021
  8. Ævar Arnfjörð BjarmasonDec 29, 2021
  9. 6/7 help: add --no-[external-commands|aliases] for use with --allÆvar Arnfjörð Bjarmason, Dec 28, 2021
  10. Eric SunshineDec 28, 2021
  11. 7/7 help: don't print "\n" before single-section outputÆvar Arnfjörð Bjarmason, Dec 28, 2021
  12. 0/9 help: tests, parse_options() sanity, fix "help -g" regressionÆvar Arnfjörð Bjarmason, Feb 21, 2022
  13. 1/9 help doc: add missing "]" to "[-a|--all]"Ævar Arnfjörð Bjarmason, Feb 21, 2022
  14. 2/9 help.c: use puts() instead of printf{,_ln}() for consistencyÆvar Arnfjörð Bjarmason, Feb 21, 2022
  15. Junio C HamanoFeb 23, 2022
  16. Ævar Arnfjörð BjarmasonFeb 23, 2022
  17. 3/9 help tests: test "git" and "git help [-a|-g] spacingÆvar Arnfjörð Bjarmason, Feb 21, 2022
  18. 6/9 help: correct usage & behavior of "git help --all"Ævar Arnfjörð Bjarmason, Feb 21, 2022
  19. Junio C HamanoFeb 23, 2022
  20. 4/9 help.c: split up list_all_cmds_help() functionÆvar Arnfjörð Bjarmason, Feb 21, 2022
  21. Junio C HamanoFeb 23, 2022
  22. 7/9 help: error if [-a|-g|-c] and [-i|-m|-w] are combinedÆvar Arnfjörð Bjarmason, Feb 21, 2022
  23. Junio C HamanoFeb 23, 2022
  24. 9/9 help: don't print "\n" before single-section outputÆvar Arnfjörð Bjarmason, Feb 21, 2022
  25. Junio C HamanoFeb 23, 2022
  26. 8/9 help: add --no-[external-commands|aliases] for use with --allÆvar Arnfjörð Bjarmason, Feb 21, 2022
  27. Junio C HamanoFeb 23, 2022
  28. 5/9 help: note the option name on option incompatibilityÆvar Arnfjörð Bjarmason, Feb 21, 2022
  29. Junio C HamanoFeb 23, 2022

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.