Skip to content

Commit da8a366

Browse files
bk2204gitster
authored andcommitted
Documentation: refactor common operations into variables
The Makefile performs several very similar tasks to convert AsciiDoc files into either HTML or DocBook. Move these items into variables to reduce the duplication. Signed-off-by: brian m. carlson <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 773ee47 commit da8a366

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

Documentation/Makefile

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,10 @@ ASCIIDOC_EXTRA =
100100
ASCIIDOC_HTML = xhtml11
101101
ASCIIDOC_DOCBOOK = docbook
102102
ASCIIDOC_CONF = -f asciidoc.conf
103+
ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF) \
104+
-agit-version=$(GIT_VERSION)
105+
TXT_TO_HTML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_HTML)
106+
TXT_TO_XML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_DOCBOOK)
103107
MANPAGE_XSL = manpage-normal.xsl
104108
XMLTO = xmlto
105109
XMLTO_EXTRA =
@@ -307,14 +311,12 @@ clean:
307311

308312
$(MAN_HTML): %.html : %.txt asciidoc.conf
309313
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
310-
$(ASCIIDOC) -b $(ASCIIDOC_HTML) -d manpage $(ASCIIDOC_CONF) \
311-
$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
314+
$(TXT_TO_HTML) -d manpage -o $@+ $< && \
312315
mv $@+ $@
313316

314317
$(OBSOLETE_HTML): %.html : %.txto asciidoc.conf
315318
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
316-
$(ASCIIDOC) -b $(ASCIIDOC_HTML) $(ASCIIDOC_CONF) \
317-
$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
319+
$(TXT_TO_HTML) -o $@+ $< && \
318320
mv $@+ $@
319321

320322
manpage-base-url.xsl: manpage-base-url.xsl.in
@@ -326,13 +328,12 @@ manpage-base-url.xsl: manpage-base-url.xsl.in
326328

327329
%.xml : %.txt asciidoc.conf
328330
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
329-
$(ASCIIDOC) -b $(ASCIIDOC_DOCBOOK) -d manpage $(ASCIIDOC_CONF) \
330-
$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
331+
$(TXT_TO_XML) -d manpage -o $@+ $< && \
331332
mv $@+ $@
332333

333334
user-manual.xml: user-manual.txt user-manual.conf
334335
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
335-
$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b $(ASCIIDOC_DOCBOOK) -d article -o $@+ $< && \
336+
$(TXT_TO_XML) -d article -o $@+ $< && \
336337
mv $@+ $@
337338

338339
technical/api-index.txt: technical/api-index-skel.txt \
@@ -341,8 +342,7 @@ technical/api-index.txt: technical/api-index-skel.txt \
341342

342343
technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
343344
$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt asciidoc.conf
344-
$(QUIET_ASCIIDOC)$(ASCIIDOC) -b $(ASCIIDOC_HTML) $(ASCIIDOC_CONF) \
345-
$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
345+
$(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt
346346

347347
XSLT = docbook.xsl
348348
XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
@@ -389,15 +389,15 @@ howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
389389
mv $@+ $@
390390

391391
$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
392-
$(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b $(ASCIIDOC_HTML) $*.txt
392+
$(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt
393393

394394
WEBDOC_DEST = /pub/software/scm/git/docs
395395

396396
howto/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
397397
$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
398398
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
399399
sed -e '1,/^$$/d' $< | \
400-
$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b $(ASCIIDOC_HTML) - >$@+ && \
400+
$(TXT_TO_HTML) - >$@+ && \
401401
mv $@+ $@
402402

403403
install-webdoc : html

0 commit comments

Comments
 (0)