git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
* [PATCH] git.txt: fix typos in 'linkgit' macro invocation
@ 2020-12-22 15:32 Philippe Blain via GitGitGadget
  2020-12-22 15:44 ` [PATCH v2] " Philippe Blain via GitGitGadget
  0 siblings, 1 reply; 3+ messages in thread
From: Philippe Blain via GitGitGadget @ 2020-12-22 15:32 UTC (permalink / raw)
  To: git; +Cc: Philippe Blain, Philippe Blain

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

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

^ permalink raw reply related	[flat|nested] 3+ messages in thread

* [PATCH v2] git.txt: fix typos in 'linkgit' macro invocation
  2020-12-22 15:32 [PATCH] git.txt: fix typos in 'linkgit' macro invocation Philippe Blain via GitGitGadget
@ 2020-12-22 15:44 ` Philippe Blain via GitGitGadget
  2020-12-22 20:05   ` Junio C Hamano
  0 siblings, 1 reply; 3+ messages in thread
From: Philippe Blain via GitGitGadget @ 2020-12-22 15:44 UTC (permalink / raw)
  To: git; +Cc: Philippe Blain, Philippe Blain

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

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

^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH v2] git.txt: fix typos in 'linkgit' macro invocation
  2020-12-22 15:44 ` [PATCH v2] " Philippe Blain via GitGitGadget
@ 2020-12-22 20:05   ` Junio C Hamano
  0 siblings, 0 replies; 3+ messages in thread
From: Junio C Hamano @ 2020-12-22 20:05 UTC (permalink / raw)
  To: Philippe Blain via GitGitGadget; +Cc: git, Philippe Blain

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

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

> 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

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2020-12-22 20:09 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-12-22 15:32 [PATCH] git.txt: fix typos in 'linkgit' macro invocation Philippe Blain via GitGitGadget
2020-12-22 15:44 ` [PATCH v2] " Philippe Blain via GitGitGadget
2020-12-22 20:05   ` Junio C Hamano

Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).