doc: remove extra quotes in generated docs

Commit Message

Kyle Lippincott Dec. 17, 2024, 11:47 p.m. UTC

From: Kyle Lippincott <[e-mail]>

Commit <FILL THIS IN> moved these variables from the Makefile to
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:

```

```

Signed-off-by: Kyle Lippincott <[e-mail]>
---
    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(-)


base-commit: 0fc57dec578fcc8dcda5cc3de6b81fa1f6719770

Comments

Junio C Hamano Dec. 18, 2024, 12:53 a.m. UTC | #1

"Kyle Lippincott via GitGitGadget" <[e-mail]> writes:

> From: Kyle Lippincott <[e-mail]>
>
> Commit <FILL THIS IN> moved these variables from the Makefile to

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

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

> Signed-off-by: Kyle Lippincott <[e-mail]>
> ---
>     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.

Patch

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=~
 apostrophe='
 backtick=`
 litdd=--
-manmanual='Git Manual'
-mansource='Git @GIT_VERSION@'
-revdate='@GIT_DATE@'
+manmanual=Git Manual
+mansource=Git @GIT_VERSION@
+revdate=@GIT_DATE@
 
 ifdef::backend-docbook[]
 [linkgit-inlinemacro]