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

From: Junio C Hamano <gitster@pobox.com>
Date: Dec 18, 2024, 01:22 UTC
Message-ID: <xmqqbjx9yedb.fsf@gitster.g>
In-Reply-To: <pull.1847.v2.git.git.1734483422181.gitgitgadget@gmail.com>

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

Show 30 quoted lines

> From: Kyle Lippincott <spectral@google.com>
>
> Commit a38edab7c8 (Makefile: generate doc versions via GIT-VERSION-GEN,
> 2024-12-06) moved these variables from the Makefile to asciidoc.conf.in.
> When doing so, some extraneous quotes were added; these are visible in
> the generated .xml files, at least, and possibly in other locations:
>
> ```
> --- a/tmp/orig-git-bisect.xml
> +++ b/Documentation/git-bisect.xml
> @@ -5,14 +5,14 @@
>  <refentry lang="en">
>  <refentryinfo>
>      <title>git-bisect(1)</title>
> -    <date>2024-12-06</date>
> -<revhistory><revision><date>2024-12-06</date></revision></revhistory>
> +    <date>'2024-12-06'</date>^M
> +<revhistory><revision><date>'2024-12-06'</date></revision></revhistory>^M
>  </refentryinfo>
>  <refmeta>
>  <refentrytitle>git-bisect</refentrytitle>
>  <manvolnum>1</manvolnum>
> -<refmiscinfo class="source">Git 2.47.1.409.g9bb10d27e7</refmiscinfo>
> -<refmiscinfo class="manual">Git Manual</refmiscinfo>
> +<refmiscinfo class="source">'Git 2.47.1.410.ga38edab7c8'</refmiscinfo>^M
> +<refmiscinfo class="manual">'Git Manual'</refmiscinfo>^M
>  </refmeta>
>  <refnamediv>
>      <refname>git-bisect</refname>
> ```

Thanks for filling the blanks in ;-)

The above differences however seem to be absorbed before these strings reach git-bisect.1 by the documentation toolchain; Running Documentation/doc-diff with --asciidoc or --asciidoctor options do not show the difference in single quotes.

Nevertheless it is a "fix" to make the conversion a38edab7c8 attempted to do a more faithful one to the original, so I'll still take it.

Thanks.