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

[PATCH v2 03/11] doc: use asciidoctor to build man pages directly

From
Felipe Contreras <felipe.contreras@gmail.com>
Date
May 21, 2021, 22:44 UTC
Message-ID
<20210521224452.530852-4-felipe.contreras@gmail.com>
In-Reply-To
<20210521224452.530852-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>
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 Documentation/Makefile | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index b68ab57239..0c654f4ec9 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 $@ $<
 
-%.1 %.5 %.7 : %.xml $(wildcard manpage*.xsl)
+ifdef TXT_TO_MAN
+%.1 %.5 %.7 : %.txt $(ASCIIDOC_DEPS)
+	$(QUIET_ASCIIDOC)$(TXT_TO_MAN) -o $@ $<
+else
+%.1 %.5 %.7 : %.xml manpage-base-url.xsl $(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 $@ $<
-- 
2.32.0.rc0
Previous: Felipe ContrerasNext: Felipe Contreras
Message 6 of 17 in “doc: asciidoctor: direct man page creation and fixes”
  1. 00/11 doc: asciidoctor: direct man page creation and fixesFelipe Contreras, May 21, 2021
  2. 01/11 doc: doc-diff: set docdate manuallyFelipe Contreras, May 21, 2021
  3. Bagas SanjayaMay 22, 2021
  4. Felipe ContrerasMay 22, 2021
  5. 02/11 doc-diff: drop --cut-footer switchFelipe Contreras, May 21, 2021
  6. 03/11 doc: use asciidoctor to build man pages directlyFelipe Contreras, May 21, 2021
  7. Felipe ContrerasJun 2, 2021
  8. 04/11 doc-diff: support asciidoctor man pagesFelipe Contreras, May 21, 2021
  9. Felipe ContrerasMay 21, 2021
  10. 05/11 doc: asciidoctor: add linkgit macros in man pagesFelipe Contreras, May 21, 2021
  11. 06/11 doc: add man pages workaround for asciidoctorFelipe Contreras, May 21, 2021
  12. 07/11 doc: asciidoctor: add hack for xrefsFelipe Contreras, May 21, 2021
  13. 08/11 doc: asciidoctor: add hack to improve linksFelipe Contreras, May 21, 2021
  14. 09/11 doc: asciidoctor: add support for baseurlFelipe Contreras, May 21, 2021
  15. 10/11 doc: asciidoctor: cleanup man page hackFelipe Contreras, May 21, 2021
  16. 11/11 doc: asciidoctor: add hack for old versionsFelipe Contreras, May 21, 2021
  17. Felipe ContrerasMay 21, 2021

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.