diff mbox series

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

Message ID 20200729133948.538-1-rybak.a.v@gmail.com (mailing list archive)
State Accepted
Commit 5942edb4ed4e4e8a0102dd66c9a5f139d7fc0a14
Headers show
Series git-help.txt: fix mentions of option --guides | expand

Commit Message

Andrei Rybak July 29, 2020, 1:39 p.m. UTC
Fix typos introduced in commit a133737b80 ("doc: include --guide option
description for "git help"", 2013-04-02).

Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
---
 Documentation/git-help.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Philip Oakley July 30, 2020, 10:56 a.m. UTC | #1
On 29/07/2020 14:39, Andrei Rybak wrote:
> Fix typos introduced in commit a133737b80 ("doc: include --guide option
> description for "git help"", 2013-04-02).
>
> Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
> ---
>  Documentation/git-help.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
> index f71db0daa2..69c0c5c34e 100644
> --- a/Documentation/git-help.txt
> +++ b/Documentation/git-help.txt
> @@ -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
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.

Acked-by: Philip Oakley <philipoakley@iee.email>
diff mbox series

Patch

diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index f71db0daa2..69c0c5c34e 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -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