Skip to contentSkip to conversation

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

PATCH Superseded Philippe Blain via GitGitGadget 2 participants 3 messages Dec 22, 2020 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 git.txt: fix typos in 'linkgit' macro invocation

From: Philippe Blain <[email protected]>

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.

---
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(-)
Documentation/git.txt +2 -2
index c463b937a86..aaa3668a7e9 100644
@@ -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

Signature · 1 line
gitgitgadget
#1 lore raw

PATCH v2 1/1 git.txt: fix typos in 'linkgit' macro invocation

From: Philippe Blain <[email protected]>

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.

---
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(-)
Documentation/git.txt +2 -2
index c463b937a86..a6d4ad0818b 100644
@@ -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

Signature · 1 line
gitgitgadget
#2 lore raw
Quoted 8 lines · Philippe Blain via GitGitGadget

From: Philippe Blain <[email protected]>

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.

Quoted 4 lines

Fix that.

---

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.

Quoted 17 lines
Documentation/git.txt +2 -2
index c463b937a86..a6d4ad0818b 100644
@@ -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