diff options
| author | Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2021-09-22 00:40:32 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2021-09-23 10:30:43 -0700 |
| commit | 9856ea6785c3dcd19ffb3946c6a9adbd16d9c1da (patch) | |
| tree | 88e9d00c645ab5436d51bc33790891c64edf60e8 /Documentation/git-help.txt | |
| parent | b40845293b57aa73d319aa1cec4184f114d8ce65 (diff) | |
| download | git-9856ea6785c3dcd19ffb3946c6a9adbd16d9c1da.tar.gz | |
help: correct usage & behavior of "git help --guides"
As noted in 65f98358c0c (builtin/help.c: add --guide option,
2013-04-02) and a133737b809 (doc: include --guide option description
for "git help", 2013-04-02) which introduced the --guide option, it
cannot be combined with e.g. <command>.
Change the command and the "SYNOPSIS" section to reflect that desired
behavior. Now that we assert this in code we don't need to
exhaustively describe the previous confusing behavior in the
documentation either, instead of silently ignoring the provided
argument we'll now error out.
The "We're done. Ignore any remaining args" comment added in
15f7d494380 (builtin/help.c: split "-a" processing into two,
2013-04-02) can now be removed, it's obvious that we're asserting the
behavior with the check of "argc".
The "--config" option is still missing from the synopsis, it will be
added in a subsequent commit where we'll fix bugs in its
implementation.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-help.txt')
| -rw-r--r-- | Documentation/git-help.txt | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 568a0b606f..cb8e3d4da9 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -8,8 +8,9 @@ git-help - Display help information about Git SYNOPSIS -------- [verse] -'git help' [-a|--all [--[no-]verbose]] [-g|--guides] +'git help' [-a|--all [--[no-]verbose]] [[-i|--info] [-m|--man] [-w|--web]] [COMMAND|GUIDE] +'git help' [-g|--guides] DESCRIPTION ----------- @@ -58,8 +59,7 @@ OPTIONS -g:: --guides:: - Prints a list of the Git concept guides on the standard output. This - option overrides any given command or guide name. + Prints a list of the Git concept guides on the standard output. -i:: --info:: |