threads / patch / 54868

patchgit.txt: fix typos in 'linkgit' macro invocation

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

## tl;dr

3 messages between Dec 22, 2020 and Dec 22, 2020. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

Philippe Blain via GitGitGadget· Dec 22, 2020, 15:32 UTC · lore

From: Philippe Blain <levraiphilippeblain@gmail.com>

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).

Fix that.

Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
---
    git.txt: fix typos in 'linkgit' macro invocation

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

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

Show changes to Documentation/git.txt +2 −2

diff --git a/Documentation/git.txt b/Documentation/git.txt
index c463b937a86..aaa3668a7e9 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

-- 
gitgitgadget

Philippe Blain via GitGitGadget· Dec 22, 2020, 15:44 UTC · re: Philippe Blain via GitGitGadget · lore

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

From: Philippe Blain <levraiphilippeblain@gmail.com>

Fix that.

Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
---
    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(-)

Show changes to Documentation/git.txt +2 −2

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

-- 
gitgitgadget

Junio C Hamano· Dec 22, 2020, 20:05 UTC · re: Philippe Blain via GitGitGadget · lore

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

"Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 12 quoted lines

> From: Philippe Blain <levraiphilippeblain@gmail.com>
>
> 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 <levraiphilippeblain@gmail.com>
> ---

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.

Show 17 quoted lines

> 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