Documentation: move some AsciiDoc parameters into variables
Asciidoctor takes slightly different arguments from AsciiDoc in some cases. It has a different name for the HTML backend and the "docbook" backend produces DocBook 5, not DocBook 4.5. Also, Asciidoctor does not accept the -f option. Move these values into variables so that they can be overridden by users wishing to use Asciidoctor instead of Asciidoc. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
brian m. carlson committed
Oct 11, 2014 at 23:37 UTC
7d61547db85df0bb16683ee191805b3646920e00
1 file changed
+11
-7
Documentation/Makefile
+11
-7
@@ -97,6 +97,9 @@ man7dir = $(mandir)/man7
97
98
ASCIIDOC = asciidoc
99
ASCIIDOC_EXTRA =
100
+ASCIIDOC_HTML = xhtml11
101
+ASCIIDOC_DOCBOOK = docbook
102
+ASCIIDOC_CONF = -f asciidoc.conf
103
MANPAGE_XSL = manpage-normal.xsl
104
XMLTO = xmlto
105
XMLTO_EXTRA =
@@ -304,13 +307,13 @@ clean:
307
308
$(MAN_HTML): %.html : %.txt asciidoc.conf
309
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
307
- $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
310
+ $(ASCIIDOC) -b $(ASCIIDOC_HTML) -d manpage $(ASCIIDOC_CONF) \
311
$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
312
mv $@+ $@
313
314
$(OBSOLETE_HTML): %.html : %.txto asciidoc.conf
315
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
313
- $(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
316
+ $(ASCIIDOC) -b $(ASCIIDOC_HTML) $(ASCIIDOC_CONF) \
317
$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
318
mv $@+ $@
319
@@ -323,13 +326,13 @@ manpage-base-url.xsl: manpage-base-url.xsl.in
326
327
%.xml : %.txt asciidoc.conf
328
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
326
- $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
329
+ $(ASCIIDOC) -b $(ASCIIDOC_DOCBOOK) -d manpage $(ASCIIDOC_CONF) \
330
$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
331
mv $@+ $@
332
333
user-manual.xml: user-manual.txt user-manual.conf
334
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
332
- $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d article -o $@+ $< && \
335
+ $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b $(ASCIIDOC_DOCBOOK) -d article -o $@+ $< && \
336
mv $@+ $@
337
338
technical/api-index.txt: technical/api-index-skel.txt \
@@ -338,7 +341,7 @@ technical/api-index.txt: technical/api-index-skel.txt \
341
342
technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
343
$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt asciidoc.conf
341
- $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
344
+ $(QUIET_ASCIIDOC)$(ASCIIDOC) -b $(ASCIIDOC_HTML) $(ASCIIDOC_CONF) \
345
$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
346
347
XSLT = docbook.xsl
@@ -386,14 +389,15 @@ howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
389
mv $@+ $@
390
391
$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
389
- $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 $*.txt
392
+ $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b $(ASCIIDOC_HTML) $*.txt
393
394
WEBDOC_DEST = /pub/software/scm/git/docs
395
396
howto/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
397
$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
398
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
396
- sed -e '1,/^$$/d' $< | $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 - >$@+ && \
399
+ sed -e '1,/^$$/d' $< | \
400
+ $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b $(ASCIIDOC_HTML) - >$@+ && \
401
mv $@+ $@
402
403
install-webdoc : html