diff options
| author | Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2022-08-04 18:28:32 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2022-08-04 14:12:23 -0700 |
| commit | dba1e5392f431e57d6a8daacf879a255b49d57fb (patch) | |
| tree | 1b95137e891c5fe2291efbc6ca331e17718ac71a /Documentation/git-help.txt | |
| parent | 936b8eb6c83fa2773b489dc365ab0cce47ba83f3 (diff) | |
| download | git-dba1e5392f431e57d6a8daacf879a255b49d57fb.tar.gz | |
git help doc: use "<doc>" instead of "<guide>"
Replace the use of "<guide>" originally introduced (as "GUIDE") in
a133737b809 (doc: include --guide option description for "git help",
2013-04-02) with the more generic "<doc>". The "<doc>" placeholder is
more generic, and one we'll be able to use as we introduce new
documentation categories.
Let's also add "<doc>" to the "git help -h" output, when it was made
to use parse_option() in in 41eb33bd0cb (help: use parseopt,
2008-02-24).
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 | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 239c68db45..bead763fd2 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -9,14 +9,14 @@ SYNOPSIS -------- [verse] 'git help' [-a|--all] [--[no-]verbose] [--[no-]external-commands] [--[no-]aliases] -'git help' [[-i|--info] [-m|--man] [-w|--web]] [<command>|<guide>] +'git help' [[-i|--info] [-m|--man] [-w|--web]] [<command>|<doc>] 'git help' [-g|--guides] 'git help' [-c|--config] DESCRIPTION ----------- -With no options and no '<command>' or '<guide>' given, the synopsis of the 'git' +With no options and no '<command>' or '<doc>' given, the synopsis of the 'git' command and a list of the most commonly used Git commands are printed on the standard output. @@ -26,8 +26,8 @@ printed on the standard output. If the option `--guides` or `-g` is given, a list of the Git concept guides is also printed on the standard output. -If a command, or a guide, is given, a manual page for that command or -guide is brought up. The 'man' program is used by default for this +If a command or other documentation is given, the relevant manual page +will be brought up. The 'man' program is used by default for this purpose, but this can be overridden by other options or configuration variables. |