]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/Makefile
Documentation/Makefile: make most operations "quiet"
[thirdparty/git.git] / Documentation / Makefile
CommitLineData
4a5d6939
MW
1MAN1_TXT= \
2 $(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
3 $(wildcard git-*.txt)) \
9e1f0a85 4 gitk.txt git.txt
30eba7bf
CC
5MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt \
6 gitrepository-layout.txt
9e1f0a85 7MAN7_TXT=gitcli.txt gittutorial.txt gittutorial-2.txt \
30eba7bf 8 gitcvs-migration.txt gitcore-tutorial.txt gitglossary.txt \
f948dd89 9 gitdiffcore.txt gitworkflows.txt
b790abb8 10
5cefc33b
JH
11MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
12MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
13MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
14
15DOC_HTML=$(MAN_HTML)
8db9307c 16
30eba7bf 17ARTICLES = howto-index
db9536c8 18ARTICLES += everyday
4a5d6939 19ARTICLES += git-tools
8db9307c 20# with their own formatting rules.
471a5ce5 21SP_ARTICLES = howto/revert-branch-rebase howto/using-merge-subtree user-manual
530e741c
JH
22API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
23SP_ARTICLES += $(API_DOCS)
24SP_ARTICLES += technical/api-index
8db9307c
JH
25
26DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
789d5774 27
b2bf34d6 28DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
2d76548b 29DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT))
b2bf34d6
DG
30DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
31
d2b8593f 32prefix?=$(HOME)
e14421b9 33bindir?=$(prefix)/bin
5d6491c7 34htmldir?=$(prefix)/share/doc/git-doc
a325a1a7 35pdfdir?=$(prefix)/share/doc/git-doc
45fd8bd3 36mandir?=$(prefix)/share/man
7b8cf0cf 37man1dir=$(mandir)/man1
4392da4d 38man5dir=$(mandir)/man5
7b8cf0cf 39man7dir=$(mandir)/man7
a682ef9f 40# DESTDIR=
87a81c83 41
1187d756 42ASCIIDOC=asciidoc
26cfcfbf 43ASCIIDOC_EXTRA =
7a2078b4 44MANPAGE_XSL = callouts.xsl
d2b8593f 45INSTALL?=install
4cb08df5 46RM ?= rm -f
6538d1ef 47DOC_REF = origin/man
6fe570de 48HTML_REF = origin/html
87a81c83 49
4739809c
DK
50infodir?=$(prefix)/share/info
51MAKEINFO=makeinfo
52INSTALL_INFO=install-info
53DOCBOOK2X_TEXI=docbook2x-texi
a325a1a7 54DBLATEX=dblatex
c680dd83
JH
55ifndef PERL_PATH
56 PERL_PATH = /usr/bin/perl
57endif
4739809c 58
95676853 59-include ../config.mak.autogen
4fa96e15 60-include ../config.mak
95676853 61
7f55cf45
JF
62ifdef ASCIIDOC8
63ASCIIDOC_EXTRA += -a asciidoc7compatible
64endif
65ifdef DOCBOOK_XSL_172
66ASCIIDOC_EXTRA += -a docbook-xsl-172
7a2078b4 67MANPAGE_XSL = manpage-1.72.xsl
7f55cf45
JF
68endif
69
b2bf34d6
DG
70#
71# Please note that there is a minor bug in asciidoc.
72# The version after 6.0.3 _will_ include the patch found here:
73# http://marc.theaimsgroup.com/?l=git&m=111558757202243&w=2
74#
75# Until that version is released you may have to apply the patch
76# yourself - yes, all 6 characters of it!
77#
78
bb230097
CJ
79QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir
80QUIET_SUBDIR1 =
81
82ifneq ($(findstring $(MAKEFLAGS),w),w)
83PRINT_DIR = --no-print-directory
84else # "make -w"
85NO_SUBDIR = :
86endif
87
88ifneq ($(findstring $(MAKEFLAGS),s),s)
89ifndef V
90 QUIET_ASCIIDOC = @echo ' ' ASCIIDOC $@;
91 QUIET_XMLTO = @echo ' ' XMLTO $@;
92 QUIET_DB2TEXI = @echo ' ' DB2TEXI $@;
93 QUIET_MAKEINFO = @echo ' ' MAKEINFO $@;
94 QUIET_DBLATEX = @echo ' ' DBLATEX $@;
95 QUIET_XSLTPROC = @echo ' ' XSLTPROC $@;
96 QUIET_GEN = @echo ' ' GEN $@;
97 QUIET_STDERR = 2> /dev/null
98 QUIET_SUBDIR0 = +@subdir=
99 QUIET_SUBDIR1 = ;$(NO_SUBDIR) echo ' ' SUBDIR $$subdir; \
100 $(MAKE) $(PRINT_DIR) -C $$subdir
101 export V
102endif
103endif
104
b2bf34d6 105all: html man
b790abb8
DG
106
107html: $(DOC_HTML)
108
4392da4d 109$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
b2bf34d6 110
4392da4d 111man: man1 man5 man7
b2bf34d6 112man1: $(DOC_MAN1)
4392da4d 113man5: $(DOC_MAN5)
b2bf34d6 114man7: $(DOC_MAN7)
b790abb8 115
5cefc33b 116info: git.info gitman.info
4739809c 117
a325a1a7
MV
118pdf: user-manual.pdf
119
b1a46b70
MH
120install: install-man
121
122install-man: man
41650765
RS
123 $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
124 $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
125 $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
126 $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
127 $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
128 $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
87a81c83 129
4739809c 130install-info: info
41650765 131 $(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
5cefc33b 132 $(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
4739809c
DK
133 if test -r $(DESTDIR)$(infodir)/dir; then \
134 $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
5cefc33b 135 $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
4739809c
DK
136 else \
137 echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
138 fi
37465016 139
a325a1a7
MV
140install-pdf: pdf
141 $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
142 $(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)
143
5d6491c7
CC
144install-html: html
145 sh ./install-webdoc.sh $(DESTDIR)$(htmldir)
146
7b8a74f3 147../GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
bb230097 148 $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
7b8a74f3
FL
149
150-include ../GIT-VERSION-FILE
151
93d69d86
JL
152#
153# Determine "include::" file references in asciidoc files.
154#
fb612d54 155doc.dep : $(wildcard *.txt) build-docdep.perl
bb230097
CJ
156 $(QUIET_GEN)$(RM) $@+ $@ && \
157 $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
a5ae8e64 158 mv $@+ $@
93d69d86 159
a5ae8e64 160-include doc.dep
37465016 161
72fe6a59
JH
162cmds_txt = cmds-ancillaryinterrogators.txt \
163 cmds-ancillarymanipulators.txt \
164 cmds-mainporcelain.txt \
165 cmds-plumbinginterrogators.txt \
166 cmds-plumbingmanipulators.txt \
89bf2077
JH
167 cmds-synchingrepositories.txt \
168 cmds-synchelpers.txt \
169 cmds-purehelpers.txt \
170 cmds-foreignscminterface.txt
72fe6a59 171
d7907392
JH
172$(cmds_txt): cmd-list.made
173
79d30668 174cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
bb230097
CJ
175 $(QUIET_GEN)$(RM) $@ && \
176 $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
d7907392 177 date >$@
b790abb8
DG
178
179clean:
4c785e50
JH
180 $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
181 $(RM) *.texi *.texi+ git.info gitman.info
530e741c
JH
182 $(RM) howto-index.txt howto/*.html doc.dep
183 $(RM) technical/api-*.html technical/api-index.txt
4cb08df5 184 $(RM) $(cmds_txt) *.made
b790abb8 185
530e741c 186$(MAN_HTML): %.html : %.txt
bb230097 187 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
7b8a74f3 188 $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
bb230097 189 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
7b8a74f3 190 mv $@+ $@
b790abb8 191
4392da4d 192%.1 %.5 %.7 : %.xml
bb230097 193 $(QUIET_XMLTO)$(RM) $@ && \
7a2078b4 194 xmlto -m $(MANPAGE_XSL) man $<
b790abb8
DG
195
196%.xml : %.txt
bb230097 197 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
7b8a74f3 198 $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
bb230097 199 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
7b8a74f3 200 mv $@+ $@
3f971fc4 201
d19fbc3c 202user-manual.xml: user-manual.txt user-manual.conf
bb230097 203 $(QUIET_ASCIIDOC)$(ASCIIDOC) -b docbook -d book $<
d19fbc3c 204
530e741c
JH
205technical/api-index.txt: technical/api-index-skel.txt \
206 technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
bb230097 207 $(QUIET_GEN)cd technical && sh ./api-index.sh
530e741c
JH
208
209$(patsubst %,%.html,$(API_DOCS) technical/api-index): %.html : %.txt
bb230097 210 $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
530e741c
JH
211 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
212
1cffddd6 213XSLT = docbook.xsl
0a3985dc 214XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
1c95c565 215
d19fbc3c 216user-manual.html: user-manual.xml
bb230097 217 $(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
d19fbc3c 218
50b3555c 219git.info: user-manual.texi
bb230097 220 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
5cefc33b 221
50b3555c 222user-manual.texi: user-manual.xml
bb230097 223 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
8b30ad01 224 $(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout | \
bb230097 225 $(PERL_PATH) fix-texi.perl >$@+ && \
5cefc33b
JH
226 mv $@+ $@
227
a325a1a7 228user-manual.pdf: user-manual.xml
bb230097
CJ
229 $(QUIET_DBLATEX)$(RM) $@+ $@ && \
230 $(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $< && \
a325a1a7
MV
231 mv $@+ $@
232
5cefc33b 233gitman.texi: $(MAN_XML) cat-texi.perl
bb230097 234 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
8b30ad01 235 ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
bb230097 236 --to-stdout $(xml) &&) true) | $(PERL_PATH) cat-texi.perl $@ >$@+ && \
5cefc33b
JH
237 mv $@+ $@
238
239gitman.info: gitman.texi
bb230097 240 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
5cefc33b
JH
241
242$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
bb230097
CJ
243 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
244 $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
5cefc33b 245 mv $@+ $@
4739809c 246
e6fc2346 247howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
bb230097
CJ
248 $(QUIET_GEN)$(RM) $@+ $@ && \
249 sh ./howto-index.sh $(wildcard howto/*.txt) >$@+ && \
e6fc2346
JH
250 mv $@+ $@
251
8db9307c 252$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
bb230097 253 $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 $*.txt
e6fc2346
JH
254
255WEBDOC_DEST = /pub/software/scm/git/docs
256
8d0991d7 257$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
bb230097
CJ
258 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
259 sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b xhtml11 - >$@+ && \
8d0991d7
JH
260 mv $@+ $@
261
e6fc2346
JH
262install-webdoc : html
263 sh ./install-webdoc.sh $(WEBDOC_DEST)
6538d1ef 264
b1a46b70
MH
265quick-install: quick-install-man
266
267quick-install-man:
5682694a 268 sh ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)
7b8a74f3 269
6fe570de
MG
270quick-install-html:
271 sh ./install-doc-quick.sh $(HTML_REF) $(DESTDIR)$(htmldir)
272
7b8a74f3 273.PHONY: .FORCE-GIT-VERSION-FILE