[v2] git.txt: fix typos in 'linkgit' macro invocation

Commit Message

Philippe Blain Dec. 22, 2020, 3:44 p.m. UTC

From: Philippe Blain <[e-mail]>

The 'linkgit' Asciidoc macro is misspelled as 'linkit' in the
description of 'GIT_SEQUENCE_EDITOR' since the addition of that variable
to git(1) in 902a126eca (doc: mention GIT_SEQUENCE_EDITOR and
'sequence.editor' more, 2020-08-31). Also, it uses two colons instead of
one.

Fix that.

Signed-off-by: Philippe Blain <[e-mail]>
---
    git.txt: fix typos in 'linkgit' macro invocation
    
    Changes since v1:
    
     * also fixed the fact that I had used two colons instead of one.
    
    Sorry for not checking the doc build before sending v1.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-934%2Fphil-blain%2Ffix-linkgit-git1-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-934/phil-blain/fix-linkgit-git1-v2
Pull-Request: https://github.com/git/git/pull/934

Range-diff vs v1:

 1:  978e328fb94 ! 1:  494173a5865 git.txt: fix typos in 'linkgit' macro invocation
     @@ Commit message
          The 'linkgit' Asciidoc macro is misspelled as 'linkit' in the
          description of 'GIT_SEQUENCE_EDITOR' since the addition of that variable
          to git(1) in 902a126eca (doc: mention GIT_SEQUENCE_EDITOR and
     -    'sequence.editor' more, 2020-08-31).
     +    'sequence.editor' more, 2020-08-31). Also, it uses two colons instead of
     +    one.
      
          Fix that.
      
     @@ Documentation/git.txt: other
       	when editing the todo list of an interactive rebase. See also
      -	linkit::git-rebase[1] and the `sequence.editor` option in
      -	linkit::git-config[1].
     -+	linkgit::git-rebase[1] and the `sequence.editor` option in
     -+	linkgit::git-config[1].
     ++	linkgit:git-rebase[1] and the `sequence.editor` option in
     ++	linkgit:git-config[1].
       
       `GIT_SSH`::
       `GIT_SSH_COMMAND`::


 Documentation/git.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)


base-commit: 6d3ef5b467eccd2769f1aa1c555d317d3c8dc707

Comments

Junio C Hamano Dec. 22, 2020, 8:05 p.m. UTC | #1

"Philippe Blain via GitGitGadget" <[e-mail]> writes:

> From: Philippe Blain <[e-mail]>
>
> The 'linkgit' Asciidoc macro is misspelled as 'linkit' in the
> description of 'GIT_SEQUENCE_EDITOR' since the addition of that variable
> to git(1) in 902a126eca (doc: mention GIT_SEQUENCE_EDITOR and
> 'sequence.editor' more, 2020-08-31). Also, it uses two colons instead of
> one.
>
> Fix that.
>
> Signed-off-by: Philippe Blain <[e-mail]>
> ---

It seems that 2.29 shipped with these typos without anybody
noticing.

How did you find them, by the way?  Anything we can do to prevent
similar mistakes with automation?

Will queue.  Thanks.

> diff --git a/Documentation/git.txt b/Documentation/git.txt
> index c463b937a86..a6d4ad0818b 100644
> --- a/Documentation/git.txt
> +++ b/Documentation/git.txt
> @@ -609,8 +609,8 @@ other
>  `GIT_SEQUENCE_EDITOR`::
>  	This environment variable overrides the configured Git editor
>  	when editing the todo list of an interactive rebase. See also
> -	linkit::git-rebase[1] and the `sequence.editor` option in
> -	linkit::git-config[1].
> +	linkgit:git-rebase[1] and the `sequence.editor` option in
> +	linkgit:git-config[1].
>  
>  `GIT_SSH`::
>  `GIT_SSH_COMMAND`::
>
> base-commit: 6d3ef5b467eccd2769f1aa1c555d317d3c8dc707

Patch

diff --git a/Documentation/git.txt b/Documentation/git.txt
index c463b937a86..a6d4ad0818b 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -609,8 +609,8 @@  other
 `GIT_SEQUENCE_EDITOR`::
 	This environment variable overrides the configured Git editor
 	when editing the todo list of an interactive rebase. See also
-	linkit::git-rebase[1] and the `sequence.editor` option in
-	linkit::git-config[1].
+	linkgit:git-rebase[1] and the `sequence.editor` option in
+	linkgit:git-config[1].
 
 `GIT_SSH`::
 `GIT_SSH_COMMAND`::