Re: [PATCH] doc: remove extra quotes in generated docs

From: Junio C Hamano <gitster@pobox.com>
Date: Dec 18, 2024, 00:53 UTC
Message-ID: <xmqqjzbxyfol.fsf@gitster.g>
In-Reply-To: <pull.1847.git.git.1734479267736.gitgitgadget@gmail.com>

"Kyle Lippincott via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Kyle Lippincott <spectral@google.com>
>
> Commit <FILL THIS IN> moved these variables from the Makefile to

a38edab7 (Makefile: generate doc versions via GIT-VERSION-GEN, 2024-12-06)

Show 7 quoted lines

> asciidoc.conf.in, and in doing so added some extraneous quotes. These
> are visible in the generated .xml files, at least, and possibly in other
> locations:
>
> ```
>
> ```

This is another <FILL THIS IN> that was missed?  Can you fill it in?

Show 25 quoted lines

> Signed-off-by: Kyle Lippincott <spectral@google.com>
> ---
>     doc: remove extra quotes in generated docs
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1847%2Fspectral54%2Fdoc-remove-extra-quotes-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1847/spectral54/doc-remove-extra-quotes-v1
> Pull-Request: https://github.com/git/git/pull/1847
>
>  Documentation/asciidoc.conf.in | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/asciidoc.conf.in b/Documentation/asciidoc.conf.in
> index dbe36a52eab..b89bccf2309 100644
> --- a/Documentation/asciidoc.conf.in
> +++ b/Documentation/asciidoc.conf.in
> @@ -21,9 +21,9 @@ tilde=&#126;
>  apostrophe=&#39;
>  backtick=&#96;
>  litdd=&#45;&#45;
> -manmanual='Git Manual'
> -mansource='Git @GIT_VERSION@'
> -revdate='@GIT_DATE@'
> +manmanual=Git Manual
> +mansource=Git @GIT_VERSION@
> +revdate=@GIT_DATE@

Since 226daba2 (Doc/Makefile: give mansource/-version/-manual attributes, 2019-09-16), We used to pass

	-amanmanual='Git Manual'

as part of the command line to invoke asciidoc, but the commit in question forgot that the single quotes are for the shell to strip and we now have them around the value of the asciidoc attribute.

Well spotted.

Thanks.