Makefile: add a knob to enable the use of Asciidoctor
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> Signed-off-by: Junio C Hamano <gitster@pobox.com>
brian m. carlson committed
Jan 22, 2017 at 02:41 UTC
ec3366eb52caad29e4cfb0a0afb605c450ad5a39
2 files changed
+18
Documentation/Makefile
+12
@@ -174,6 +174,18 @@ ifdef GNU_ROFF
174
XMLTO_EXTRA += -m manpage-quote-apos.xsl
175
endif
176
177
+ifdef USE_ASCIIDOCTOR
178
+ASCIIDOC = asciidoctor
179
+ASCIIDOC_CONF =
180
+ASCIIDOC_HTML = xhtml5
181
+ASCIIDOC_DOCBOOK = docbook45
182
+ifdef ASCIIDOCTOR_EXTENSIONS_LAB
183
+ASCIIDOC_EXTRA = -I$(ASCIIDOCTOR_EXTENSIONS_LAB) -rasciidoctor/extensions -rman-inline-macro
184
+endif
185
+ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;'
186
+DBLATEX_COMMON =
187
+endif
188
+
189
SHELL_PATH ?= $(SHELL)
190
# Shell quote;
191
SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
Makefile
+6
@@ -250,6 +250,12 @@ all::
250
# apostrophes to be ASCII so that cut&pasting examples to the shell
251
# will work.
252
#
253
+# Define USE_ASCIIDOCTOR to use Asciidoctor instead of AsciiDoc to build the
254
+# documentation.
255
+#
256
+# Define ASCIIDOCTOR_EXTENSIONS_LAB to point to the location of the Asciidoctor
257
+# Extensions Lab if you have it available.
258
+#
259
# Define PERL_PATH to the path of your Perl binary (usually /usr/bin/perl).
260
#
261
# Define NO_PERL_MAKEMAKER if you cannot use Makefiles generated by perl's