Skip to content

Commit 853878d

Browse files
committed
Merge branch 'bc/asciidoctor'
Add machinery to alternatively use AsciiDoctor to format our documentation. * bc/asciidoctor: Documentation: remove Asciidoctor linkgit macro Documentation: refactor common operations into variables Documentation: implement linkgit macro for Asciidoctor Documentation: move some AsciiDoc parameters into variables
2 parents fbecd99 + c6c3e0d commit 853878d

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

Documentation/Makefile

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,13 @@ man7dir = $(mandir)/man7
9999

100100
ASCIIDOC = asciidoc
101101
ASCIIDOC_EXTRA =
102+
ASCIIDOC_HTML = xhtml11
103+
ASCIIDOC_DOCBOOK = docbook
104+
ASCIIDOC_CONF = -f asciidoc.conf
105+
ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF) \
106+
-agit-version=$(GIT_VERSION)
107+
TXT_TO_HTML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_HTML)
108+
TXT_TO_XML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_DOCBOOK)
102109
MANPAGE_XSL = manpage-normal.xsl
103110
XMLTO = xmlto
104111
XMLTO_EXTRA =
@@ -306,14 +313,12 @@ clean:
306313

307314
$(MAN_HTML): %.html : %.txt asciidoc.conf
308315
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
309-
$(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
310-
$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
316+
$(TXT_TO_HTML) -d manpage -o $@+ $< && \
311317
mv $@+ $@
312318

313319
$(OBSOLETE_HTML): %.html : %.txto asciidoc.conf
314320
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
315-
$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
316-
$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
321+
$(TXT_TO_HTML) -o $@+ $< && \
317322
mv $@+ $@
318323

319324
manpage-base-url.xsl: manpage-base-url.xsl.in
@@ -325,13 +330,12 @@ manpage-base-url.xsl: manpage-base-url.xsl.in
325330

326331
%.xml : %.txt asciidoc.conf
327332
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
328-
$(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
329-
$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
333+
$(TXT_TO_XML) -d manpage -o $@+ $< && \
330334
mv $@+ $@
331335

332336
user-manual.xml: user-manual.txt user-manual.conf
333337
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
334-
$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d article -o $@+ $< && \
338+
$(TXT_TO_XML) -d article -o $@+ $< && \
335339
mv $@+ $@
336340

337341
technical/api-index.txt: technical/api-index-skel.txt \
@@ -340,8 +344,7 @@ technical/api-index.txt: technical/api-index-skel.txt \
340344

341345
technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
342346
$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt asciidoc.conf
343-
$(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
344-
$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
347+
$(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt
345348

346349
XSLT = docbook.xsl
347350
XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
@@ -388,14 +391,15 @@ howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
388391
mv $@+ $@
389392

390393
$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
391-
$(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 $*.txt
394+
$(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt
392395

393396
WEBDOC_DEST = /pub/software/scm/git/docs
394397

395398
howto/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
396399
$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
397400
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
398-
sed -e '1,/^$$/d' $< | $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 - >$@+ && \
401+
sed -e '1,/^$$/d' $< | \
402+
$(TXT_TO_HTML) - >$@+ && \
399403
mv $@+ $@
400404

401405
install-webdoc : html

0 commit comments

Comments
 (0)