Skip to contentSkip to conversation

git-help.txt: fix mentions of option --guides

PATCH In review Andrei Rybak 2 participants 2 messages Jul 29, 2020 – Jul 30, 2020 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 git-help.txt: fix mentions of option --guides

Fix typos introduced in commit a133737b80 ("doc: include --guide option description for "git help"", 2013-04-02).

---
 Documentation/git-help.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/git-help.txt +2 -2
index f71db0daa2..69c0c5c34e 100644
@@ -8,7 +8,7 @@ git-help - Display help information about Git
 SYNOPSIS
 --------
 [verse]
-'git help' [-a|--all [--[no-]verbose]] [-g|--guide]
+'git help' [-a|--all [--[no-]verbose]] [-g|--guides]
 	   [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE]
 
 DESCRIPTION
@@ -21,7 +21,7 @@ on the standard output.
 If the option `--all` or `-a` is given, all available commands are
 printed on the standard output.
 
-If the option `--guide` or `-g` is given, a list of the useful
+If the option `--guides` or `-g` is given, a list of the useful
 Git guides is also printed on the standard output.
 
 If a command, or a guide, is given, a manual page for that command or
Signature · 1 line
2.28.0.windows.1
Acked-by on v1 1/1
#1 lore raw
Quoted 22 lines · Andrei Rybak

Fix typos introduced in commit a133737b80 ("doc: include --guide option description for "git help"", 2013-04-02).

---
 Documentation/git-help.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/git-help.txt +1 -1
index f71db0daa2..69c0c5c34e 100644
@@ -8,7 +8,7 @@ git-help - Display help information about Git
 SYNOPSIS
 --------
 [verse]
-'git help' [-a|--all [--[no-]verbose]] [-g|--guide]
+'git help' [-a|--all [--[no-]verbose]] [-g|--guides]
 	   [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE]
 
 DESCRIPTION

Documentation/git-help.txt on the standard output. · line 27

Quoted 8 lines
Documentation/git-help.txt +1 -1
@@ -21,7 +21,7 @@ on the standard output.
 If the option `--all` or `-a` is given, all available commands are
 printed on the standard output.
 
-If the option `--guide` or `-g` is given, a list of the useful
+If the option `--guides` or `-g` is given, a list of the useful
 Git guides is also printed on the standard output.
 
 If a command, or a guide, is given, a manual page for that command or

Looks like the error was all mine, all the way back to my a133737b80 (doc: include --guide option description for "git help", 2013-04-02)

The majority of that change referred to individual 'guide'(singular), however the option to list them is in the plural. I didn't find any other errorss (other than the referenced commit's subject;-) , but a note as in this commit message about the singular/plural confusion may be worth having if there is a re-roll.