From: "Martin Ågren" <martin.agren@gmail.com>
To: git@vger.kernel.org
Cc: "Todd Zullinger" <tmz@pobox.com>, "Jeff King" <peff@peff.net>,
"SZEDER Gábor" <szeder.dev@gmail.com>,
"brian m. carlson" <sandals@crustytoothpaste.net>,
"Junio C Hamano" <gitster@pobox.com>
Subject: [PATCH v3 1/3] Doc/Makefile: give mansource/-version/-manual attributes
Date: Mon, 16 Sep 2019 21:00:26 +0200 [thread overview]
Message-ID: <bf80b9a66f23a287c447509a33dbb2ec97ac2a64.1568658269.git.martin.agren@gmail.com> (raw)
In-Reply-To: <cover.1568658269.git.martin.agren@gmail.com>
Rather than hardcoding "Git Manual" and "Git" as the manual and source
in asciidoc.conf, provide them as attributes `manmanual` and
`mansource`. Rename the `git_version` attribute to `manversion`.
These new attribute names are not arbitrary, see, e.g., [1].
For AsciiDoc (8.6.10) and Asciidoctor <1.5.7, this is a no-op. Starting
with Asciidoctor 1.5.7, `manmanual` and `mansource` actually end up in
the xml-files and eventually in the rendered manpages. In particular,
the manpage headers now render just as with AsciiDoc.
No versions of Asciidoctor pick up the `manversion` [2], and older
versions don't pick up any of these attributes. -- We'll fix that with a
bit of a hack in the next commit.
[1] https://asciidoctor.org/docs/user-manual/#man-pages
[2] Note how [1] says "Not used by Asciidoctor".
Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
Documentation/Makefile | 3 ++-
Documentation/asciidoc.conf | 6 +++---
2 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index dbf5a0f276..a67bc04ae8 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -122,7 +122,8 @@ ASCIIDOC_HTML = xhtml11
ASCIIDOC_DOCBOOK = docbook
ASCIIDOC_CONF = -f asciidoc.conf
ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF) \
- -agit_version=$(GIT_VERSION)
+ -amanversion=$(GIT_VERSION) \
+ -amanmanual='Git Manual' -amansource='Git'
TXT_TO_HTML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_HTML)
TXT_TO_XML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_DOCBOOK)
MANPAGE_XSL = manpage-normal.xsl
diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf
index 2c16c536ba..8fc4b67081 100644
--- a/Documentation/asciidoc.conf
+++ b/Documentation/asciidoc.conf
@@ -78,9 +78,9 @@ template::[header-declarations]
<refmeta>
<refentrytitle>{mantitle}</refentrytitle>
<manvolnum>{manvolnum}</manvolnum>
-<refmiscinfo class="source">Git</refmiscinfo>
-<refmiscinfo class="version">{git_version}</refmiscinfo>
-<refmiscinfo class="manual">Git Manual</refmiscinfo>
+<refmiscinfo class="source">{mansource}</refmiscinfo>
+<refmiscinfo class="version">{manversion}</refmiscinfo>
+<refmiscinfo class="manual">{manmanual}</refmiscinfo>
</refmeta>
<refnamediv>
<refname>{manname}</refname>
--
2.23.0
next prev parent reply other threads:[~2019-09-16 19:00 UTC|newest]
Thread overview: 71+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-17 14:47 [PATCH] asciidoctor-extensions: provide `<refmiscinfo/>` Martin Ågren
2019-03-17 19:44 ` Todd Zullinger
2019-03-17 20:03 ` Martin Ågren
2019-03-19 7:02 ` Martin Ågren
2019-03-20 18:17 ` Todd Zullinger
2019-03-22 21:01 ` Martin Ågren
2019-03-23 19:27 ` Todd Zullinger
2019-03-24 12:16 ` Jeff King
2019-03-24 16:21 ` Todd Zullinger
2019-03-25 15:06 ` Jeff King
2019-03-25 19:00 ` Todd Zullinger
2019-03-27 1:06 ` Todd Zullinger
2019-03-27 10:05 ` SZEDER Gábor
2019-03-28 0:06 ` brian m. carlson
2019-03-30 18:00 ` Todd Zullinger
2019-03-30 21:04 ` brian m. carlson
2019-04-05 2:17 ` Todd Zullinger
2019-04-05 18:46 ` Jeff King
2019-03-28 2:54 ` Jeff King
2019-03-28 3:33 ` Jeff King
2019-03-19 2:46 ` Jeff King
2019-03-19 2:59 ` Jeff King
2019-03-19 3:55 ` Junio C Hamano
2019-03-19 7:33 ` Martin Ågren
2019-03-19 7:36 ` Martin Ågren
2019-09-03 18:51 ` [PATCH v2 0/2] " Martin Ågren
2019-09-03 18:51 ` [PATCH v2 1/2] " Martin Ågren
2019-09-03 18:51 ` [PATCH v2 2/2] doc-diff: replace --cut-header-footer with --cut-footer Martin Ågren
2019-09-03 23:16 ` [PATCH v2 0/2] asciidoctor-extensions: provide `<refmiscinfo/>` brian m. carlson
2019-09-05 19:28 ` Martin Ågren
2019-09-04 3:26 ` Jeff King
2019-09-05 19:35 ` Martin Ågren
2019-09-07 6:45 ` Jeff King
2019-09-07 14:06 ` Martin Ågren
2019-09-08 21:30 ` Jeff King
2019-09-06 23:29 ` brian m. carlson
2019-09-07 4:40 ` Jeff King
2019-09-07 16:53 ` brian m. carlson
2019-09-07 17:07 ` [PATCH] Documentation: fix build with Asciidoctor 2 brian m. carlson
2019-09-08 10:48 ` Jeff King
2019-09-08 17:18 ` brian m. carlson
2019-09-08 21:21 ` Jeff King
2019-09-08 22:24 ` brian m. carlson
2019-09-09 17:37 ` Junio C Hamano
2019-09-10 18:44 ` Jeff King
2019-09-11 23:19 ` brian m. carlson
2019-09-08 14:13 ` SZEDER Gábor
2019-09-08 21:32 ` Jeff King
2019-09-13 1:52 ` [PATCH v2] " brian m. carlson
2019-09-13 5:06 ` Jeff King
2019-09-13 17:06 ` Junio C Hamano
2019-09-16 10:47 ` Martin Ågren
2019-09-16 17:43 ` Junio C Hamano
2019-09-14 7:53 ` SZEDER Gábor
2019-09-14 19:44 ` brian m. carlson
2019-09-14 19:49 ` [PATCH v3] " brian m. carlson
2019-09-15 9:59 ` SZEDER Gábor
2019-09-15 21:26 ` brian m. carlson
2019-09-15 22:05 ` SZEDER Gábor
2019-09-15 22:14 ` brian m. carlson
2019-09-16 10:51 ` Martin Ågren
2019-09-15 22:43 ` [PATCH v4] " brian m. carlson
2019-09-16 19:00 ` [PATCH v3 0/3] asciidoctor-extensions: provide `<refmiscinfo/>` Martin Ågren
2019-09-16 19:00 ` Martin Ågren [this message]
2019-09-16 19:00 ` [PATCH v3 2/3] " Martin Ågren
2019-09-16 19:00 ` [PATCH v3 3/3] doc-diff: replace --cut-header-footer with --cut-footer Martin Ågren
2019-03-19 3:30 ` [PATCH] asciidoctor-extensions: provide `<refmiscinfo/>` Jeff King
2019-03-19 7:12 ` Martin Ågren
2019-03-19 7:43 ` Jeff King
2019-03-20 18:32 ` Todd Zullinger
2019-03-19 7:10 ` Martin Ågren
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=bf80b9a66f23a287c447509a33dbb2ec97ac2a64.1568658269.git.martin.agren@gmail.com \
--to=martin.agren@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
--cc=sandals@crustytoothpaste.net \
--cc=szeder.dev@gmail.com \
--cc=tmz@pobox.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).