Skip to content

Commit dba1e53

Browse files
avargitster
authored andcommitted
git help doc: use "<doc>" instead of "<guide>"
Replace the use of "<guide>" originally introduced (as "GUIDE") in a133737 (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 41eb33b (help: use parseopt, 2008-02-24). Signed-off-by: Ævar Arnfjörð Bjarmason <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 936b8eb commit dba1e53

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

Documentation/git-help.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ SYNOPSIS
99
--------
1010
[verse]
1111
'git help' [-a|--all] [--[no-]verbose] [--[no-]external-commands] [--[no-]aliases]
12-
'git help' [[-i|--info] [-m|--man] [-w|--web]] [<command>|<guide>]
12+
'git help' [[-i|--info] [-m|--man] [-w|--web]] [<command>|<doc>]
1313
'git help' [-g|--guides]
1414
'git help' [-c|--config]
1515

1616
DESCRIPTION
1717
-----------
1818

19-
With no options and no '<command>' or '<guide>' given, the synopsis of the 'git'
19+
With no options and no '<command>' or '<doc>' given, the synopsis of the 'git'
2020
command and a list of the most commonly used Git commands are printed
2121
on the standard output.
2222

@@ -26,8 +26,8 @@ printed on the standard output.
2626
If the option `--guides` or `-g` is given, a list of the
2727
Git concept guides is also printed on the standard output.
2828

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
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
3131
purpose, but this can be overridden by other options or configuration
3232
variables.
3333

builtin/help.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ static struct option builtin_help_options[] = {
8181

8282
static const char * const builtin_help_usage[] = {
8383
"git help [-a|--all] [--[no-]verbose]] [--[no-]external-commands] [--[no-]aliases]",
84-
N_("git help [[-i|--info] [-m|--man] [-w|--web]] [<command>]"),
84+
N_("git help [[-i|--info] [-m|--man] [-w|--web]] [<command>|<doc>]"),
8585
"git help [-g|--guides]",
8686
"git help [-c|--config]",
8787
NULL

0 commit comments

Comments
 (0)