From: Felipe Contreras <felipe.contreras@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Martin Ågren" <martin.agren@gmail.com>,
"brian m . carlson" <sandals@crustytoothpaste.net>,
"Felipe Contreras" <felipe.contreras@gmail.com>
Subject: [PATCH v4 03/12] doc: simplify version passing
Date: Tue, 8 Jun 2021 04:00:17 -0500 [thread overview]
Message-ID: <20210608090026.1737348-4-felipe.contreras@gmail.com> (raw)
In-Reply-To: <20210608090026.1737348-1-felipe.contreras@gmail.com>
The code to pass the version of the man page comes from 2007:
7ef195ba3e (Documentation: Add version information to man pages,
2007-03-25). However, both asciidoc and asciidoctor already do this by
default.
Asciidoctor doesn't read manversion, but there's no need since both
tools just join mansource and manversion.
Let's do that ourselves and get rid of a bunch of code.
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
Documentation/Makefile | 3 +--
Documentation/asciidoc.conf | 19 -------------------
Documentation/asciidoctor-extensions.rb | 17 -----------------
3 files changed, 1 insertion(+), 38 deletions(-)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 84643a34e9..47053c78f8 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -137,8 +137,7 @@ ASCIIDOC_HTML = xhtml11
ASCIIDOC_DOCBOOK = docbook
ASCIIDOC_CONF = -f asciidoc.conf
ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF) \
- -amanversion=$(GIT_VERSION) \
- -amanmanual='Git Manual' -amansource='Git'
+ -amanmanual='Git Manual' -amansource='Git $(GIT_VERSION)'
ASCIIDOC_DEPS = asciidoc.conf GIT-ASCIIDOCFLAGS
TXT_TO_HTML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_HTML)
TXT_TO_XML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_DOCBOOK)
diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf
index 3e4c13971b..60f76f43ed 100644
--- a/Documentation/asciidoc.conf
+++ b/Documentation/asciidoc.conf
@@ -51,25 +51,6 @@ ifdef::doctype-manpage[]
endif::doctype-manpage[]
endif::backend-docbook[]
-ifdef::doctype-manpage[]
-ifdef::backend-docbook[]
-[header]
-template::[header-declarations]
-<refentry>
-<refmeta>
-<refentrytitle>{mantitle}</refentrytitle>
-<manvolnum>{manvolnum}</manvolnum>
-<refmiscinfo class="source">{mansource}</refmiscinfo>
-<refmiscinfo class="version">{manversion}</refmiscinfo>
-<refmiscinfo class="manual">{manmanual}</refmiscinfo>
-</refmeta>
-<refnamediv>
- <refname>{manname}</refname>
- <refpurpose>{manpurpose}</refpurpose>
-</refnamediv>
-endif::backend-docbook[]
-endif::doctype-manpage[]
-
ifdef::backend-xhtml11[]
[attributes]
git-relative-html-prefix=
diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb
index d906a00803..70a0956663 100644
--- a/Documentation/asciidoctor-extensions.rb
+++ b/Documentation/asciidoctor-extensions.rb
@@ -23,26 +23,9 @@ module Git
end
end
end
-
- class DocumentPostProcessor < Asciidoctor::Extensions::Postprocessor
- def process document, output
- if document.basebackend? 'docbook'
- mansource = document.attributes['mansource']
- manversion = document.attributes['manversion']
- manmanual = document.attributes['manmanual']
- new_tags = "" \
- "<refmiscinfo class=\"source\">#{mansource}</refmiscinfo>\n" \
- "<refmiscinfo class=\"version\">#{manversion}</refmiscinfo>\n" \
- "<refmiscinfo class=\"manual\">#{manmanual}</refmiscinfo>\n"
- output = output.sub(/<\/refmeta>/, new_tags + "</refmeta>")
- end
- output
- end
- end
end
end
Asciidoctor::Extensions.register do
inline_macro Git::Documentation::LinkGitProcessor, :linkgit
- postprocessor Git::Documentation::DocumentPostProcessor
end
--
2.32.0.2.g41be0a4e50
next prev parent reply other threads:[~2021-06-08 9:00 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-08 9:00 [PATCH v4 00/12] doc: cleanup old cruft and asciidoctor revamp Felipe Contreras
2021-06-08 9:00 ` [PATCH v4 01/12] doc: remove GNU troff workaround Felipe Contreras
2021-06-08 9:00 ` [PATCH v4 02/12] doc: use --stringparam in xmlto Felipe Contreras
2021-06-08 9:00 ` Felipe Contreras [this message]
2021-06-08 9:00 ` [PATCH v4 04/12] doc: asciidoc: remove unnecessary attribute Felipe Contreras
2021-06-08 9:00 ` [PATCH v4 05/12] doc: asciidoctor: remove unnecessary require Felipe Contreras
2021-06-08 9:00 ` [PATCH v4 06/12] doc: asciidoctor: remove cruft Felipe Contreras
2021-06-08 9:00 ` [PATCH v4 07/12] doc: asciidoctor: reorganize extensions Felipe Contreras
2021-06-08 9:00 ` [PATCH v4 08/12] doc: asciidoctor: use html-prefix only for html Felipe Contreras
2021-06-08 9:00 ` [PATCH v4 09/12] doc: asciidoctor: refactor macro registration Felipe Contreras
2021-06-08 9:00 ` [PATCH v4 10/12] doc: asciidoctor: improve string handling Felipe Contreras
2021-06-08 9:00 ` [PATCH v4 11/12] doc: asciidoctor: split the format from the code Felipe Contreras
2021-06-08 9:00 ` [PATCH v4 12/12] doc: asciidoctor: specify name of our group Felipe Contreras
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=20210608090026.1737348-4-felipe.contreras@gmail.com \
--to=felipe.contreras@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=martin.agren@gmail.com \
--cc=sandals@crustytoothpaste.net \
/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).