freshlybakedca.ke / git
Git fork
fork atom

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>

authored by

Ævar Arnfjörð Bjarmason and committed by
Junio C Hamano dba1e539 936b8eb6

+5 -5
unified split
+4 -4
Documentation/git-help.txt
··· 9 -------- 10 [verse] 11 'git help' [-a|--all] [--[no-]verbose] [--[no-]external-commands] [--[no-]aliases] 12 - 'git help' [[-i|--info] [-m|--man] [-w|--web]] [<command>|<guide>] 13 'git help' [-g|--guides] 14 'git help' [-c|--config] 15 16 DESCRIPTION 17 ----------- 18 19 - With no options and no '<command>' or '<guide>' given, the synopsis of the 'git' 20 command and a list of the most commonly used Git commands are printed 21 on the standard output. 22 ··· 26 If the option `--guides` or `-g` is given, a list of the 27 Git concept guides is also printed on the standard output. 28 29 - If a command, or a guide, is given, a manual page for that command or 30 - guide is brought up. The 'man' program is used by default for this 31 purpose, but this can be overridden by other options or configuration 32 variables. 33
··· 9 -------- 10 [verse] 11 'git help' [-a|--all] [--[no-]verbose] [--[no-]external-commands] [--[no-]aliases] 12 + 'git help' [[-i|--info] [-m|--man] [-w|--web]] [<command>|<doc>] 13 'git help' [-g|--guides] 14 'git help' [-c|--config] 15 16 DESCRIPTION 17 ----------- 18 19 + With no options and no '<command>' or '<doc>' given, the synopsis of the 'git' 20 command and a list of the most commonly used Git commands are printed 21 on the standard output. 22 ··· 26 If the option `--guides` or `-g` is given, a list of the 27 Git concept guides is also printed on the standard output. 28 29 + If a command or other documentation is given, the relevant manual page 30 + will be brought up. The 'man' program is used by default for this 31 purpose, but this can be overridden by other options or configuration 32 variables. 33
+1 -1
builtin/help.c
··· 81 82 static const char * const builtin_help_usage[] = { 83 "git help [-a|--all] [--[no-]verbose]] [--[no-]external-commands] [--[no-]aliases]", 84 - N_("git help [[-i|--info] [-m|--man] [-w|--web]] [<command>]"), 85 "git help [-g|--guides]", 86 "git help [-c|--config]", 87 NULL
··· 81 82 static const char * const builtin_help_usage[] = { 83 "git help [-a|--all] [--[no-]verbose]] [--[no-]external-commands] [--[no-]aliases]", 84 + N_("git help [[-i|--info] [-m|--man] [-w|--web]] [<command>|<doc>]"), 85 "git help [-g|--guides]", 86 "git help [-c|--config]", 87 NULL