All of lore.kernel.org
 help / color / mirror / Atom feed
From: "brian m. carlson" <sandals@crustytoothpaste.net>
To: git@vger.kernel.org
Cc: Johannes Schindelin <Johannes.Schindelin@gmx.de>,
	Jeff King <peff@peff.net>
Subject: [PATCH v2 7/7] Makefile: add a knob to enable the use of Asciidoctor
Date: Sun, 22 Jan 2017 02:41:56 +0000	[thread overview]
Message-ID: <20170122024156.284180-8-sandals@crustytoothpaste.net> (raw)
In-Reply-To: <20170122024156.284180-1-sandals@crustytoothpaste.net>

While Git has traditionally built its documentation using AsciiDoc, some
people wish to use Asciidoctor for speed or other reasons.  Add a
Makefile knob, USE_ASCIIDOCTOR, that sets various options in order to
produce acceptable output.  For HTML output, XHTML5 was chosen, since
the AsciiDoc options also produce XHTML, albeit XHTML 1.1.

Asciidoctor does not have built-in support for the linkgit macro, but it
is available using the Asciidoctor Extensions Lab.  Add a macro to
enable the use of this extension if it is available.  Without it, the
linkgit macros are emitted into the output.

Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
---
 Documentation/Makefile | 12 ++++++++++++
 Makefile               |  6 ++++++
 2 files changed, 18 insertions(+)

diff --git a/Documentation/Makefile b/Documentation/Makefile
index d95002e62..19c42eb60 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -174,6 +174,18 @@ ifdef GNU_ROFF
 XMLTO_EXTRA += -m manpage-quote-apos.xsl
 endif
 
+ifdef USE_ASCIIDOCTOR
+ASCIIDOC = asciidoctor
+ASCIIDOC_CONF =
+ASCIIDOC_HTML = xhtml5
+ASCIIDOC_DOCBOOK = docbook45
+ifdef ASCIIDOCTOR_EXTENSIONS_LAB
+ASCIIDOC_EXTRA = -I$(ASCIIDOCTOR_EXTENSIONS_LAB) -rasciidoctor/extensions -rman-inline-macro
+endif
+ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;'
+DBLATEX_COMMON =
+endif
+
 SHELL_PATH ?= $(SHELL)
 # Shell quote;
 SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
diff --git a/Makefile b/Makefile
index 27afd0f37..7ed9d4d4b 100644
--- a/Makefile
+++ b/Makefile
@@ -250,6 +250,12 @@ all::
 # apostrophes to be ASCII so that cut&pasting examples to the shell
 # will work.
 #
+# Define USE_ASCIIDOCTOR to use Asciidoctor instead of AsciiDoc to build the
+# documentation.
+#
+# Define ASCIIDOCTOR_EXTENSIONS_LAB to point to the location of the Asciidoctor
+# Extensions Lab if you have it available.
+#
 # Define PERL_PATH to the path of your Perl binary (usually /usr/bin/perl).
 #
 # Define NO_PERL_MAKEMAKER if you cannot use Makefiles generated by perl's

  parent reply	other threads:[~2017-01-22  2:42 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-01-22  2:41 [PATCH v2 0/7] Macros for Asciidoctor support brian m. carlson
2017-01-22  2:41 ` [PATCH v2 1/7] Documentation: fix warning in cat-texi.perl brian m. carlson
2017-01-22  2:41 ` [PATCH v2 2/7] Documentation: modernize cat-texi.perl brian m. carlson
2017-01-22  2:41 ` [PATCH v2 3/7] Documentation: remove unneeded argument in cat-texi.perl brian m. carlson
2017-01-22  2:41 ` [PATCH v2 4/7] Documentation: sort sources for gitman.texi brian m. carlson
2017-01-22  2:41 ` [PATCH v2 5/7] Documentation: add XSLT to fix DocBook for Texinfo brian m. carlson
2017-01-22  2:41 ` [PATCH v2 6/7] Documentation: move dblatex arguments into variable brian m. carlson
2017-01-22  2:41 ` brian m. carlson [this message]
2017-01-23  2:57   ` [PATCH v2 7/7] Makefile: add a knob to enable the use of Asciidoctor Øyvind A. Holm
2017-01-23  4:09     ` brian m. carlson
2017-01-25  2:26       ` Øyvind A. Holm
2017-01-23 18:59 ` [PATCH v2 0/7] Macros for Asciidoctor support Junio C Hamano
2017-01-25 13:28 ` Johannes Schindelin
2017-01-25 21:35   ` Jeff King
2017-01-25 23:19     ` brian m. carlson
2017-01-25 23:30       ` Jeff King
2017-01-25 23:41         ` brian m. carlson
2017-01-26  0:13           ` [PATCH] Documentation: implement linkgit macro for Asciidoctor brian m. carlson
2017-01-26  3:46             ` Jeff King
2017-01-26  7:43               ` Eric Wong
     [not found]                 ` <xmqq1svp7lcs.fsf@gitster.mtv.corp.google.com>
2017-01-26 19:18                   ` Eric Wong
2017-01-27  0:40                     ` brian m. carlson
2017-01-31 20:20                       ` Junio C Hamano
2017-01-26 11:43             ` Johannes Schindelin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170122024156.284180-8-sandals@crustytoothpaste.net \
    --to=sandals@crustytoothpaste.net \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=git@vger.kernel.org \
    --cc=peff@peff.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.