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

From: Junio C Hamano <gitster@pobox.com>
Date: Dec 22, 2020, 20:05 UTC
Message-ID: <xmqqsg7xhaht.fsf@gitster.c.googlers.com>
In-Reply-To: <pull.934.v2.git.git.1608651882510.gitgitgadget@gmail.com>

"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