git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v2 0/3] Allow building Git with Asciidoctor
@ 2014-10-20  0:20 brian m. carlson
  2014-10-20  0:20 ` [PATCH v2 1/3] Documentation: adjust document title underlining brian m. carlson
                   ` (4 more replies)
  0 siblings, 5 replies; 6+ messages in thread
From: brian m. carlson @ 2014-10-20  0:20 UTC (permalink / raw)
  To: git; +Cc: Jeff King, Junio C Hamano, Jakub Narębski

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=--'" \
  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

^ permalink raw reply	[flat|nested] 6+ messages in thread
end of thread, other threads:[~2014-10-20 19:08 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-10-20  0:20 [PATCH v2 0/3] Allow building Git with Asciidoctor brian m. carlson
2014-10-20  0:20 ` [PATCH v2 1/3] Documentation: adjust document title underlining brian m. carlson
2014-10-20  0:20 ` [PATCH v2 2/3] Documentation: fix mismatched delimiters in git-imap-send brian m. carlson
2014-10-20  0:20 ` [PATCH v2 3/3] Documentation: move some AsciiDoc parameters into variables brian m. carlson
2014-10-20  9:24 ` [PATCH v2 0/3] Allow building Git with Asciidoctor Jeff King
2014-10-20 19:08 ` Junio C Hamano

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).