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

[PATCH v2 0/7] Macros for Asciidoctor support

From
brian m. carlson <sandals@crustytoothpaste.net>
Date
Jan 22, 2017, 02:41 UTC
Message-ID
<20170122024156.284180-1-sandals@crustytoothpaste.net>

There are two major processors of AsciiDoc: AsciiDoc itself, and Asciidoctor. Both have advantages and disadvantages, but traditionally the documentation has been built with AsciiDoc, leading to some surprising breakage when building with Asciidoctor. Partially, this is due to the need to specify a significant number of macros on the command line when building with Asciidoctor.

This series cleans up some issues building the documentation with Asciidoctor and provides two knobs, USE_ASCIIDOCTOR, which controls building with Asciidoctor, and ASCIIDOCTOR_EXTENSIONS_LAB, which controls the location of the Asciidoctor Extensions Lab, which is necessary to expand the linkgit macro.

The need for the extensions could be replaced with a small amount of Ruby code, if that's considered desirable. Previous opinions on doing so were negative, however.

In the process, I found several issues with cat-texi.perl, which have been fixed. It has also been modernized to use strict, warnings, and lexical file handles. I also made an attempt to produce more diffable texi files; I may follow up with additional series along this line to make the documentation build reproducibly.

Changes from v1:
* Fix a brown-paper-bag bug.
brian m. carlson (7):
  Documentation: fix warning in cat-texi.perl
  Documentation: modernize cat-texi.perl
  Documentation: remove unneeded argument in cat-texi.perl
  Documentation: sort sources for gitman.texi
  Documentation: add XSLT to fix DocBook for Texinfo
  Documentation: move dblatex arguments into variable
  Makefile: add a knob to enable the use of Asciidoctor
 Documentation/Makefile      | 22 ++++++++++++++++++----
 Documentation/cat-texi.perl | 21 ++++++++++++---------
 Documentation/texi.xsl      | 26 ++++++++++++++++++++++++++
 Makefile                    |  6 ++++++
 4 files changed, 62 insertions(+), 13 deletions(-)
 create mode 100644 Documentation/texi.xsl
Next: brian m. carlson
Message 1 of 24 in “Macros for Asciidoctor support”
  1. 0/7 Macros for Asciidoctor supportbrian m. carlson, Jan 22, 2017
  2. 1/7 Documentation: fix warning in cat-texi.perlbrian m. carlson, Jan 22, 2017
  3. 4/7 Documentation: sort sources for gitman.texibrian m. carlson, Jan 22, 2017
  4. 3/7 Documentation: remove unneeded argument in cat-texi.perlbrian m. carlson, Jan 22, 2017
  5. 2/7 Documentation: modernize cat-texi.perlbrian m. carlson, Jan 22, 2017
  6. 6/7 Documentation: move dblatex arguments into variablebrian m. carlson, Jan 22, 2017
  7. 7/7 Makefile: add a knob to enable the use of Asciidoctorbrian m. carlson, Jan 22, 2017
  8. Øyvind A. HolmJan 23, 2017
  9. brian m. carlsonJan 23, 2017
  10. Øyvind A. HolmJan 25, 2017
  11. 5/7 Documentation: add XSLT to fix DocBook for Texinfobrian m. carlson, Jan 22, 2017
  12. Junio C HamanoJan 23, 2017
  13. Johannes SchindelinJan 25, 2017
  14. Jeff KingJan 25, 2017
  15. brian m. carlsonJan 25, 2017
  16. Jeff KingJan 25, 2017
  17. brian m. carlsonJan 25, 2017
  18. Documentation: implement linkgit macro for Asciidoctorbrian m. carlson, Jan 26, 2017
  19. Jeff KingJan 26, 2017
  20. Eric WongJan 26, 2017
  21. Johannes SchindelinJan 26, 2017
  22. Eric WongJan 26, 2017
  23. brian m. carlsonJan 27, 2017
  24. Junio C HamanoJan 31, 2017

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.