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

[PATCH 0/4] Allow building Git with Asciidoctor

From
brian m. carlson <sandals@crustytoothpaste.net>
Date
Oct 11, 2014, 23:37 UTC
Message-ID
<1413070656-241955-1-git-send-email-sandals@crustytoothpaste.net>

This series is designed to implement the changes necessary to build Git using Asciidoctor instead of AsciiDoc.

The first two patches are bug fixes. Asciidoctor is stricter about title underline lengths (± 1 character instead of 2) and requires matching delimiter lengths[0]. They're needed regardless of whether the other two patches are accepted because git-scm.com uses Asciidoctor to render the documentation, so we might as well render it correctly.

Even with these patches, Asciidoctor warns about everyday.txt and user-manual.txt. I'm not sending patches for these right now because I've seen recent series including those and don't want to cause a merge conflict.

The second two patches implement some basic support for building with Asciidoctor. The first of these moves some items into variables due to some differences between the AsciiDoc and Asciidoctor command lines. The user can then override these values when invoking make.

The final patch adds support for the linkgit macro. Asciidoctor uses Ruby extensions to implement macro support, unlike AsciiDoc, which uses a configuration file.

In order to build the documentation successfully, the patches from [1] are required. The current version of Asciidoctor uses the wrong elements in some cases and is lacking elements in others when generating manpage (refentry) output in DocBook format. The need for these patches is also the reason I didn't implement a configuration macro for Asciidoctor, as almost nobody will be able to use it at the moment.

With these patches and the ones for Asciidoctor, it's possible to build the documentation with the following command line:

  make doc ASCIIDOC=asciidoctor ASCIIDOC_DOCBOOK=docbook45 ASCIIDOC_HTML=html5 ASCIIDOC_CONF='-I. -rasciidoctor/extensions -rextensions'
brian m. carlson (4):
  Documentation: adjust document title underlining
  Documentation: fix mismatched delimiters in git-imap-send
  Documentation: move some AsciiDoc parameters into variables
  Documentation: implement linkgit macro for Asciidoctor
 Documentation/Makefile             | 18 +++++++++++-------
 Documentation/extensions.rb        | 39 ++++++++++++++++++++++++++++++++++++++
 Documentation/git-imap-send.txt    |  4 ++--
 Documentation/git-prune-packed.txt |  2 +-
 Documentation/git-quiltimport.txt  |  2 +-
 Documentation/git-stage.txt        |  2 +-
 6 files changed, 55 insertions(+), 12 deletions(-)
 create mode 100644 Documentation/extensions.rb

[0] http://asciidoctor.org/docs/asciidoc-asciidoctor-diffs/ [1] https://github.com/asciidoctor/asciidoctor/pull/1142

-- 
2.1.1
Next: brian m. carlson
Message 1 of 19 in “Allow building Git with Asciidoctor”
  1. 0/4 Allow building Git with Asciidoctorbrian m. carlson, Oct 11, 2014
  2. 1/4 Documentation: adjust document title underliningbrian m. carlson, Oct 11, 2014
  3. Junio C HamanoOct 13, 2014
  4. 2/4 Documentation: fix mismatched delimiters in git-imap-sendbrian m. carlson, Oct 11, 2014
  5. 3/4 Documentation: move some AsciiDoc parameters into variablesbrian m. carlson, Oct 11, 2014
  6. Junio C HamanoOct 15, 2014
  7. brian m. carlsonOct 16, 2014
  8. 4/4 Documentation: implement linkgit macro for Asciidoctorbrian m. carlson, Oct 11, 2014
  9. Junio C HamanoOct 13, 2014
  10. brian m. carlsonOct 14, 2014
  11. Jakub NarębskiOct 14, 2014
  12. brian m. carlsonOct 14, 2014
  13. Jeff KingOct 14, 2014
  14. Junio C HamanoOct 14, 2014
  15. brian m. carlsonOct 15, 2014
  16. Junio C HamanoOct 15, 2014
  17. Thomas BraunOct 15, 2014
  18. brian m. carlsonOct 15, 2014
  19. Philip OakleyOct 16, 2014

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.