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

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

From
Felipe Contreras <felipe.contreras@gmail.com>
Date
May 14, 2021, 12:14 UTC
Message-ID
<20210514121435.504423-5-felipe.contreras@gmail.com>
In-Reply-To
<20210514121435.504423-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 USE_ASCIIDOCTOR is set.
Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 Documentation/Makefile | 6 ++++++
 1 file changed, 6 insertions(+)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 981e322f18..ce9cea0817 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -198,6 +198,7 @@ ASCIIDOC_DEPS = asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
 DBLATEX_COMMON =
 XMLTO_EXTRA += --skip-validation
 XMLTO_EXTRA += -x manpage.xsl
+TXT_TO_MAN = $(ASCIIDOC_COMMON) -b manpage
 endif
 
 SHELL_PATH ?= $(SHELL)
@@ -362,8 +363,13 @@ $(OBSOLETE_HTML): %.html : %.txto $(ASCIIDOC_DEPS)
 manpage-base-url.xsl: manpage-base-url.xsl.in
 	$(QUIET_GEN)sed "s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|" $< > $@
 
+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.31.1
Previous: Felipe ContrerasNext: Martin Ågren
Message 16 of 25 in “doc: asciidoctor: direct man page creation and fixes”
  1. 00/11 doc: asciidoctor: direct man page creation and fixesFelipe Contreras, May 14, 2021
  2. 01/11 doc: allow the user to provide ASCIIDOC_EXTRAFelipe Contreras, May 14, 2021
  3. Jeff KingMay 15, 2021
  4. Jeff KingMay 15, 2021
  5. Felipe ContrerasMay 15, 2021
  6. Jeff KingMay 17, 2021
  7. Felipe ContrerasMay 17, 2021
  8. Jeff KingMay 17, 2021
  9. Felipe ContrerasMay 17, 2021
  10. 02/11 doc: doc-diff: allow more than one flagFelipe Contreras, May 14, 2021
  11. Jeff KingMay 15, 2021
  12. Felipe ContrerasMay 15, 2021
  13. 03/11 doc: doc-diff: set docdate manuallyFelipe Contreras, May 14, 2021
  14. Martin ÅgrenMay 14, 2021
  15. Felipe ContrerasMay 14, 2021
  16. 04/11 doc: use asciidoctor to build man pages directlyFelipe Contreras, May 14, 2021
  17. Martin ÅgrenMay 14, 2021
  18. Felipe ContrerasMay 14, 2021
  19. 05/11 doc: asciidoctor: add linkgit macros in man pagesFelipe Contreras, May 14, 2021
  20. 06/11 doc: join mansource and manversionFelipe Contreras, May 14, 2021
  21. 07/11 doc: add man pages workaround for asciidoctorFelipe Contreras, May 14, 2021
  22. 08/11 doc: asciidoctor: add hack for xrefsFelipe Contreras, May 14, 2021
  23. 09/11 doc: asciidoctor: add hack to improve linksFelipe Contreras, May 14, 2021
  24. 10/11 doc: asciidoctor: add support for baseurlFelipe Contreras, May 14, 2021
  25. 11/11 doc: asciidoctor: cleanup man page hackFelipe Contreras, May 14, 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.