kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

git help doc: use "<doc>" instead of "<guide>" 

Replace the use of "<guide>" originally introduced (as "GUIDE") in
a133737b80 (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 41eb33bd0c (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>
maint
Ævar Arnfjörð Bjarmason 2022-08-04 18:28:32 +02:00 committed by Junio C Hamano
parent 936b8eb6c8
commit dba1e5392f
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/git-help.txt
View File

@ -9,14 +9,14 @@ SYNOPSIS
-------- --------
[verse] [verse]
'git help' [-a|--all] [--[no-]verbose] [--[no-]external-commands] [--[no-]aliases] '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' [-g|--guides]
'git help' [-c|--config] 'git help' [-c|--config]


DESCRIPTION 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 command and a list of the most commonly used Git commands are printed
on the standard output. 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 If the option `--guides` or `-g` is given, a list of the
Git concept guides is also printed on the standard output. 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 If a command or other documentation is given, the relevant manual page
guide is brought up. The 'man' program is used by default for this will be brought up. The 'man' program is used by default for this
purpose, but this can be overridden by other options or configuration purpose, but this can be overridden by other options or configuration
variables. variables.



2
builtin/help.c
View File

@ -81,7 +81,7 @@ static struct option builtin_help_options[] = {


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