All of lore.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Kyle Lippincott via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org,  Kyle Lippincott <spectral@google.com>
Subject: Re: [PATCH v2] doc: remove extra quotes in generated docs
Date: Tue, 17 Dec 2024 17:22:08 -0800	[thread overview]
Message-ID: <xmqqbjx9yedb.fsf@gitster.g> (raw)
In-Reply-To: <pull.1847.v2.git.git.1734483422181.gitgitgadget@gmail.com> (Kyle Lippincott via GitGitGadget's message of "Wed, 18 Dec 2024 00:57:02 +0000")

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

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

  parent reply	other threads:[~2024-12-18  1:22 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-12-17 23:47 [PATCH] doc: remove extra quotes in generated docs Kyle Lippincott via GitGitGadget
2024-12-18  0:53 ` Junio C Hamano
2024-12-18  0:57 ` [PATCH v2] " Kyle Lippincott via GitGitGadget
2024-12-18  1:11   ` Junio C Hamano
2024-12-18  1:22   ` Junio C Hamano [this message]
2024-12-18 11:33     ` make GIT_VERSION=foo broken, was " Jeff King
2024-12-18 13:19       ` Patrick Steinhardt
2024-12-18 12:13   ` Jeff King

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqbjx9yedb.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=spectral@google.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.