From: Felipe Contreras <felipe.contreras@gmail.com>
To: git@vger.kernel.org
Cc: "Martin Ågren" <martin.agren@gmail.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Bagas Sanjaya" <bagasdotme@gmail.com>,
"Jeff King" <peff@peff.net>, "Junio C Hamano" <gitster@pobox.com>,
"brian m . carlson" <sandals@crustytoothpaste.net>,
"Felipe Contreras" <felipe.contreras@gmail.com>
Subject: [PATCH 15/23] doc: use asciidoctor to build man pages directly
Date: Mon, 21 Jun 2021 11:31:02 -0500 [thread overview]
Message-ID: <20210621163110.1074145-16-felipe.contreras@gmail.com> (raw)
In-Reply-To: <20210621163110.1074145-1-felipe.contreras@gmail.com>
There's no need to use xmlto to build the man pages when modern
asciidoctor can do it by itself.
This new mode will be active only when both USE_ASCIIDOCTOR and
USE_ASCIIDOCTOR_MANPAGE are set.
Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com>
Suggestions-by: Jeff King <peff@peff.net>
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
Documentation/Makefile | 10 +++++++++-
Makefile | 4 ++++
2 files changed, 13 insertions(+), 1 deletion(-)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index b68ab57239..e6af1848cc 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -189,6 +189,9 @@ ASCIIDOC_DEPS = asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
DBLATEX_COMMON =
XMLTO_EXTRA += --skip-validation
XMLTO_EXTRA += -x manpage.xsl
+ifdef USE_ASCIIDOCTOR_MANPAGE
+TXT_TO_MAN = $(ASCIIDOC_COMMON) -b manpage
+endif
endif
SHELL_PATH ?= $(SHELL)
@@ -324,7 +327,7 @@ mergetools-list.made: ../git-mergetool--lib.sh $(wildcard ../mergetools/*)
show_tool_names can_merge "* " || :' >mergetools-merge.txt && \
date >$@
-TRACK_ASCIIDOCFLAGS = $(subst ','\'',$(ASCIIDOC_COMMON):$(ASCIIDOC_HTML):$(ASCIIDOC_DOCBOOK))
+TRACK_ASCIIDOCFLAGS = $(subst ','\'',$(ASCIIDOC_COMMON):$(ASCIIDOC_HTML):$(ASCIIDOC_DOCBOOK):$(USE_ASCIIDOCTOR_MANPAGE))
GIT-ASCIIDOCFLAGS: FORCE
@FLAGS='$(TRACK_ASCIIDOCFLAGS)'; \
@@ -349,8 +352,13 @@ $(MAN_HTML): %.html : %.txt $(ASCIIDOC_DEPS)
$(OBSOLETE_HTML): %.html : %.txto $(ASCIIDOC_DEPS)
$(QUIET_ASCIIDOC)$(TXT_TO_HTML) -o $@ $<
+ifdef TXT_TO_MAN
+%.1 %.5 %.7 : %.txt $(ASCIIDOC_DEPS)
+ $(QUIET_ASCIIDOC)$(TXT_TO_MAN) -o $@ $<
+else
%.1 %.5 %.7 : %.xml $(wildcard manpage*.xsl)
$(QUIET_XMLTO)$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
+endif
%.xml : %.txt $(ASCIIDOC_DEPS)
$(QUIET_ASCIIDOC)$(TXT_TO_XML) -d manpage -o $@ $<
diff --git a/Makefile b/Makefile
index 7588c43f05..ab3fa362b7 100644
--- a/Makefile
+++ b/Makefile
@@ -281,6 +281,10 @@ all::
# Define USE_ASCIIDOCTOR to use Asciidoctor instead of AsciiDoc to build the
# documentation.
#
+# Define USE_ASCIIDOCTOR_MANPAGE to use Asciidoctor's manual page backend
+# instead of building manual pages from DocBook (using xmlto). Has no effect
+# unless USE_ASCIIDOCTOR is set.
+#
# Define ASCIIDOCTOR_EXTENSIONS_LAB to point to the location of the Asciidoctor
# Extensions Lab if you have it available.
#
--
2.32.0
next prev parent reply other threads:[~2021-06-21 16:59 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-21 16:30 [PATCH 00/23] doc: cleanups and asciidoctor direct man pages Felipe Contreras
2021-06-21 16:30 ` [PATCH 01/23] doc: remove GNU troff workaround Felipe Contreras
2021-06-21 16:30 ` [PATCH 02/23] doc: use --stringparam in xmlto Felipe Contreras
2021-06-21 16:30 ` [PATCH 03/23] doc: simplify version passing Felipe Contreras
2021-06-21 16:30 ` [PATCH 04/23] doc: asciidoc: remove unnecessary attribute Felipe Contreras
2021-06-21 16:30 ` [PATCH 05/23] doc: asciidoctor: remove unnecessary require Felipe Contreras
2021-06-21 16:30 ` [PATCH 06/23] doc: asciidoctor: remove cruft Felipe Contreras
2021-06-21 16:30 ` [PATCH 07/23] doc: asciidoctor: reorganize extensions Felipe Contreras
2021-06-21 16:30 ` [PATCH 08/23] doc: asciidoctor: use html-prefix only for html Felipe Contreras
2021-06-21 16:30 ` [PATCH 09/23] doc: asciidoctor: refactor macro registration Felipe Contreras
2021-06-21 16:30 ` [PATCH 10/23] doc: asciidoctor: improve string handling Felipe Contreras
2021-06-21 16:30 ` [PATCH 11/23] doc: asciidoctor: split the format from the code Felipe Contreras
2021-06-21 16:30 ` [PATCH 12/23] doc: asciidoctor: specify name of our group Felipe Contreras
2021-06-21 16:31 ` [PATCH 13/23] doc: doc-diff: set docdate manually Felipe Contreras
2021-06-21 16:31 ` [PATCH 14/23] doc-diff: drop --cut-footer switch Felipe Contreras
2021-06-21 16:31 ` Felipe Contreras [this message]
2021-06-22 5:23 ` [PATCH 15/23] doc: use asciidoctor to build man pages directly Bagas Sanjaya
2021-06-23 1:35 ` Felipe Contreras
2021-06-21 16:31 ` [PATCH 16/23] doc-diff: support asciidoctor man pages Felipe Contreras
2021-06-21 16:31 ` [PATCH 17/23] doc: asciidoctor: add linkgit macros in " Felipe Contreras
2021-06-21 16:31 ` [PATCH 18/23] doc: add man pages workaround for asciidoctor Felipe Contreras
2021-06-21 16:31 ` [PATCH 19/23] doc: asciidoctor: add hack for xrefs Felipe Contreras
2021-06-21 16:31 ` [PATCH 20/23] doc: asciidoctor: add hack to improve links Felipe Contreras
2021-06-21 16:31 ` [PATCH 21/23] doc: asciidoctor: add support for baseurl Felipe Contreras
2021-06-21 16:31 ` [PATCH 22/23] doc: asciidoctor: cleanup man page hack Felipe Contreras
2021-06-21 16:31 ` [PATCH 23/23] doc: asciidoctor: add hack for old versions Felipe Contreras
2021-06-22 5:35 ` [PATCH 00/23] doc: cleanups and asciidoctor direct man pages Bagas Sanjaya
2021-06-23 1:37 ` 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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210621163110.1074145-16-felipe.contreras@gmail.com \
--to=felipe.contreras@gmail.com \
--cc=avarab@gmail.com \
--cc=bagasdotme@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=martin.agren@gmail.com \
--cc=peff@peff.net \
--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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).