git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Kyle Lippincott via GitGitGadget <gitgitgadget@gmail.com>
Date
Dec 18, 2024, 00:57 UTC
Message-ID
<pull.1847.v2.git.git.1734483422181.gitgitgadget@gmail.com>
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
Previous: Junio C HamanoNext: Junio C Hamano
Message 3 of 8 in “doc: remove extra quotes in generated docs”
  1. doc: remove extra quotes in generated docsKyle Lippincott via GitGitGadget, Dec 17, 2024
  2. Junio C HamanoDec 18, 2024
  3. doc: remove extra quotes in generated docsKyle Lippincott via GitGitGadget, Dec 18, 2024
  4. Junio C HamanoDec 18, 2024
  5. Junio C HamanoDec 18, 2024
  6. make GIT_VERSION=foo broken, was Re: [PATCH v2] doc: remove extra quotes in generated docsJeff King, Dec 18, 2024
  7. Patrick SteinhardtDec 18, 2024
  8. Jeff KingDec 18, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.