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

[PATCH v2 0/3] Allow building Git with Asciidoctor

From
brian m. carlson <sandals@crustytoothpaste.net>
Date
Oct 20, 2014, 00:20 UTC
Message-ID
<1413764438-297386-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, and are unchanged from v1. Asciidoctor is stricter about some aspects of formatting, and these patches are required to make the documentation build correctly.

The third patch moves several pieces of the documentation makefile into variables. Some of these changes were suggested by Junio, and some of them were required to simply build correctly.

In this patch, I have maintained the ASCIIDOC_HTML and ASCIIDOC_DOCBOOK variables, because otherwise there is no way to override the backends easily, which is required to build. For Asciidoctor, there is no xhtml11 backend and the docbook backend produces DocBook 5, which xmlto doesn't like.

The fourth patch in the previous series has been dropped, as Dan Allen of the Asciidoctor project has pointed me to a backend-agnostic implementation of the linkgit macro which is included in the Asciidoctor project. The litdd attribute, the only other missing piece, can be moved to the command line, so the patch became unnecessary.

I've successfully built the documentation with Asciidoctor using the following command line:

  make doc ASCIIDOC=asciidoctor ASCIIDOC_HTML=html5 \
  ASCIIDOC_DOCBOOK=docbook45 ASCIIDOC_EXTRA="'-alitdd=&#45;&#45;'" \
  ASCIIDOC_CONF=

This resulted in a total build time (documentation only) of 3:17 versus 5:43 for AsciiDoc (a 42% improvement).

brian m. carlson (3):
  Documentation: adjust document title underlining
  Documentation: fix mismatched delimiters in git-imap-send
  Documentation: move some AsciiDoc parameters into variables
 Documentation/Makefile             | 26 +++++++++++++++-----------
 Documentation/git-imap-send.txt    |  4 ++--
 Documentation/git-prune-packed.txt |  2 +-
 Documentation/git-quiltimport.txt  |  2 +-
 Documentation/git-stage.txt        |  2 +-
 5 files changed, 20 insertions(+), 16 deletions(-)
-- 
2.1.1
Next: brian m. carlson
Message 1 of 6 in “Allow building Git with Asciidoctor”
  1. 0/3 Allow building Git with Asciidoctorbrian m. carlson, Oct 20, 2014
  2. 1/3 Documentation: adjust document title underliningbrian m. carlson, Oct 20, 2014
  3. 2/3 Documentation: fix mismatched delimiters in git-imap-sendbrian m. carlson, Oct 20, 2014
  4. 3/3 Documentation: move some AsciiDoc parameters into variablesbrian m. carlson, Oct 20, 2014
  5. Jeff KingOct 20, 2014
  6. Junio C HamanoOct 20, 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.