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

[PATCH 00/11] doc: asciidoctor: direct man page creation and fixes

From
Felipe Contreras <felipe.contreras@gmail.com>
Date
May 14, 2021, 12:14 UTC
Message-ID
<20210514121435.504423-1-felipe.contreras@gmail.com>

This patch series enables direct man page creation with asciidoctor, but in addition tries to minimize the difference with asciidoc+docbook.

I fixed as many issues as I could, and now the doc-diff looks very sensible. I could not find any major issues, however, some minor issues still remain.

On the other hand the asciidoc method has issues as well, so it's not clear which method is superior at this point; both have advantages and disadvantages.

At the very least the man pages with pure asciidoctor should be quite usable now.
This series builds on top of my cleanups [1]. It's probably not worth the effort to split the two.
[1] https://lore.kernel.org/git/20210514115631.503276-1-felipe.contreras@gmail.com
Felipe Contreras (11):
  doc: allow the user to provide ASCIIDOC_EXTRA
  doc: doc-diff: allow more than one flag
  doc: doc-diff: set docdate manually
  doc: use asciidoctor to build man pages directly
  doc: asciidoctor: add linkgit macros in man pages
  doc: join mansource and manversion
  doc: add man pages workaround for asciidoctor
  doc: asciidoctor: add hack for xrefs
  doc: asciidoctor: add hack to improve links
  doc: asciidoctor: add support for baseurl
  doc: asciidoctor: cleanup man page hack
 Documentation/Makefile                  | 24 ++++++++-----
 Documentation/asciidoctor-extensions.rb | 46 +++++++++++++++++++++++++
 Documentation/doc-diff                  |  8 ++---
 3 files changed, 65 insertions(+), 13 deletions(-)
-- 
2.31.1
Next: Felipe Contreras
Message 1 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.