diff options
| author | Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2022-02-21 20:38:49 +0100 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2022-02-23 22:41:37 +0100 |
| commit | 5e8068b74df8d0c58042a3ffe1c09dbffbbc63f7 (patch) | |
| tree | 6f63b8369125001a165150a8b065b533127a609c /Documentation | |
| parent | help: note the option name on option incompatibility (diff) | |
| download | git-5e8068b74df8d0c58042a3ffe1c09dbffbbc63f7.tar.xz git-5e8068b74df8d0c58042a3ffe1c09dbffbbc63f7.zip | |
help: correct usage & behavior of "git help --all"
Do the same for the "--all" option that I did for "--guides" in
9856ea6785c (help: correct usage & behavior of "git help --guides",
2021-09-22). I.e. we've documented it as ignoring non-option
arguments, let's have it error out instead.
As with other changes made in 62f035aee3f (Merge branch
'ab/help-config-vars', 2021-10-13) this is technically a change in
behavior, but in practice it's just a bug fix. We were ignoring this
before, but by erroring we can simplify our documentation and
synopsis, as well as avoid user confusion as they wonder what the
difference between e.g. "git help --all" and "git help --all status"
is (there wasn't any difference).
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-help.txt | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index cf1d53e949..d07590c8ff 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'git help' [-a|--all] [--[no-]verbose] - [[-i|--info] [-m|--man] [-w|--web]] [<command>|<guide>] +'git help' [[-i|--info] [-m|--man] [-w|--web]] [<command>|<guide>] 'git help' [-g|--guides] 'git help' [-c|--config] @@ -46,8 +46,7 @@ OPTIONS ------- -a:: --all:: - Prints all the available commands on the standard output. This - option overrides any given command or guide name. + Prints all the available commands on the standard output. --verbose:: When used with `--all` print description for all recognized |