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

[PATCH v2 04/11] doc-diff: support asciidoctor man pages

From
Felipe Contreras <felipe.contreras@gmail.com>
Date
May 21, 2021, 22:44 UTC
Message-ID
<20210521224452.530852-5-felipe.contreras@gmail.com>
In-Reply-To
<20210521224452.530852-1-felipe.contreras@gmail.com>
From: Jeff King <peff@peff.net>

The new option enables both asciidoctor as well as its direct-to-manpage mode that skips xmlto. This lets you view the rendered difference between the two pipelines with something like:

  ./doc-diff --from-asciidoctor --to-asciidoctor-direct HEAD HEAD
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 Documentation/doc-diff | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
diff --git a/Documentation/doc-diff b/Documentation/doc-diff
index 6b6bb444ac..52cf639f4d 100755
--- a/Documentation/doc-diff
+++ b/Documentation/doc-diff
@@ -17,10 +17,14 @@ f			force rebuild; do not rely on cached results
 c,clean			cleanup temporary working files
 from-asciidoc		use asciidoc with the 'from'-commit
 from-asciidoctor	use asciidoctor with the 'from'-commit
+from-asciidoctor-direct use asciidoctor without xmlto for 'from'-commit
 asciidoc		use asciidoc with both commits
 to-asciidoc		use asciidoc with the 'to'-commit
 to-asciidoctor		use asciidoctor with the 'to'-commit
+to-asciidoctor-direct   use asciidoctor without xmlto for 'to'-commit
 asciidoctor		use asciidoctor with both commits
+asciidoctor-direct      use asciidoctor without xml for both commits
+cut-footer		cut away footer
 "
 SUBDIRECTORY_OK=1
 . "$(git --exec-path)/git-sh-setup"
@@ -53,6 +57,15 @@ do
 	--asciidoc)
 		from_program=-asciidoc
 		to_program=-asciidoc ;;
+	--cut-footer)
+		cut_footer=-cut-footer ;;
+	--from-asciidoctor-direct)
+		from_program=-asciidoctor-direct ;;
+	--to-asciidoctor-direct)
+		to_program=-asciidoctor-direct ;;
+	--asciidoctor-direct)
+		from_program=-asciidoctor-direct
+		to_program=-asciidoctor-direct ;;
 	--)
 		shift; break ;;
 	*)
@@ -108,6 +121,10 @@ construct_makemanflags () {
 	elif test "$1" = "-asciidoctor"
 	then
 		echo USE_ASCIIDOCTOR=YesPlease ASCIIDOC_FLAGS='-adocdate="01/01/1970"'
+	elif test "$1" = "-asciidoctor-direct"
+	then
+		echo USE_ASCIIDOCTOR=YesPlease ASCIIDOC_FLAGS='-adocdate="01/01/1970"'
+		echo USE_ASCIIDOCTOR_MANPAGE=YesPlease
 	fi
 }
 
-- 
2.32.0.rc0
Previous: Felipe ContrerasNext: Felipe Contreras
Message 8 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.