git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Kyle Lippincott via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Kyle Lippincott <spectral@google.com>,
	Kyle Lippincott <spectral@google.com>
Subject: [PATCH v2] doc: remove extra quotes in generated docs
Date: Wed, 18 Dec 2024 00:57:02 +0000	[thread overview]
Message-ID: <pull.1847.v2.git.git.1734483422181.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1847.git.git.1734479267736.gitgitgadget@gmail.com>

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

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-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1847/spectral54/doc-remove-extra-quotes-v2
Pull-Request: https://github.com/git/git/pull/1847

Range-diff vs v1:

 1:  c4f2acc9b07 ! 1:  89ce6212c02 doc: remove extra quotes in generated docs
     @@ Metadata
       ## Commit message ##
          doc: remove extra quotes in generated docs
      
     -    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:
     +    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>
          ```
      
          Signed-off-by: Kyle Lippincott <spectral@google.com>


 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@
 
 ifdef::backend-docbook[]
 [linkgit-inlinemacro]

base-commit: 0fc57dec578fcc8dcda5cc3de6b81fa1f6719770
-- 
gitgitgadget

  parent reply	other threads:[~2024-12-18  0:57 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 ` Kyle Lippincott via GitGitGadget [this message]
2024-12-18  1:11   ` [PATCH v2] " Junio C Hamano
2024-12-18  1:22   ` Junio C Hamano
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=pull.1847.v2.git.git.1734483422181.gitgitgadget@gmail.com \
    --to=gitgitgadget@gmail.com \
    --cc=git@vger.kernel.org \
    --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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).