diff options
| author | Philippe Blain <levraiphilippeblain@gmail.com> | 2020-08-05 01:19:05 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2020-08-05 01:34:01 (GMT) |
| commit | 0371a764d2db05e13a87bc1fc16600a1a576e9fe (patch) | |
| tree | faa94874fe13225f25277a90d36c81d348ea8f2a /Documentation/git-help.txt | |
| parent | 2135e1ad7037f72c1a96d4ae11eef8e0ed1cbc65 (diff) | |
| download | git-0371a764d2db05e13a87bc1fc16600a1a576e9fe.zip git-0371a764d2db05e13a87bc1fc16600a1a576e9fe.tar.gz git-0371a764d2db05e13a87bc1fc16600a1a576e9fe.tar.bz2 | |
help: drop usage of 'common' and 'useful' for guides
Since 1b81d8cb19 (help: use command-list.txt for the source of guides,
2018-05-20), all man5/man7 guides listed in command-list.txt appear in
the output of 'git help -g'.
However, 'git help -g' still prefixes this list with "The common Git
guides are:", which makes one wonder if there are others!
In the same spirit, the man page for 'git help' describes the '--guides'
option as listing 'useful' guides, which is not false per se but can
also be taken to mean that there are other guides that exist but are not
useful.
Instead of 'common' and 'useful', use 'Git concept guides' in both
places. To keep the code in line with this change, rename
help.c::list_common_guides_help to list_guides_help.
Signed-off-by: Philippe Blain <levraiphilippeblain@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 69c0c5c..44fe886 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -21,8 +21,8 @@ on the standard output. If the option `--all` or `-a` is given, all available commands are printed on the standard output. -If the option `--guides` or `-g` is given, a list of the useful -Git guides is also 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 @@ -58,7 +58,7 @@ OPTIONS -g:: --guides:: - Prints a list of useful guides on the standard output. This + Prints a list of the Git concept guides on the standard output. This option overrides any given command or guide name. -i:: |