Merge branch 'maint-1.6.2' into maint-1.6.3
[git/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 =
c30e9485 44MANPAGE_XSL = manpage-normal.xsl
5121a6d9 45XMLTO_EXTRA =
d2b8593f 46INSTALL?=install
4cb08df5 47RM ?= rm -f
6538d1ef 48DOC_REF = origin/man
6fe570de 49HTML_REF = origin/html
87a81c83 50
4739809c
DK
51infodir?=$(prefix)/share/info
52MAKEINFO=makeinfo
53INSTALL_INFO=install-info
54DOCBOOK2X_TEXI=docbook2x-texi
a325a1a7 55DBLATEX=dblatex
c680dd83
JH
56ifndef PERL_PATH
57 PERL_PATH = /usr/bin/perl
58endif
4739809c 59
95676853 60-include ../config.mak.autogen
4fa96e15 61-include ../config.mak
95676853 62
8fa2b45f
CJ
63#
64# For asciidoc ...
65# -7.1.2, no extra settings are needed.
66# 8.0-, set ASCIIDOC8.
67#
68
69#
70# For docbook-xsl ...
71# -1.68.1, set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0)
2346431e
CJ
72# 1.69.0, no extra settings are needed?
73# 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP?
74# 1.71.1, no extra settings are needed?
8fa2b45f
CJ
75# 1.72.0, set DOCBOOK_XSL_172.
76# 1.73.0-, set ASCIIDOC_NO_ROFF
77#
78
79#
80# If you had been using DOCBOOK_XSL_172 in an attempt to get rid
81# of 'the ".ft C" problem' in your generated manpages, and you
82# instead ended up with weird characters around callouts, try
83# using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8).
84#
85
7f55cf45
JF
86ifdef ASCIIDOC8
87ASCIIDOC_EXTRA += -a asciidoc7compatible
88endif
89ifdef DOCBOOK_XSL_172
8fa2b45f 90ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
7a2078b4 91MANPAGE_XSL = manpage-1.72.xsl
8fa2b45f
CJ
92else
93 ifdef ASCIIDOC_NO_ROFF
94 # docbook-xsl after 1.72 needs the regular XSL, but will not
95 # pass-thru raw roff codes from asciidoc.conf, so turn them off.
96 ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
97 endif
7f55cf45 98endif
5121a6d9
CJ
99ifdef MAN_BOLD_LITERAL
100XMLTO_EXTRA += -m manpage-bold-literal.xsl
101endif
2346431e
CJ
102ifdef DOCBOOK_SUPPRESS_SP
103XMLTO_EXTRA += -m manpage-suppress-sp.xsl
104endif
7f55cf45 105
ee7ec2f9
BW
106SHELL_PATH ?= $(SHELL)
107# Shell quote;
108SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
109
b2bf34d6
DG
110#
111# Please note that there is a minor bug in asciidoc.
112# The version after 6.0.3 _will_ include the patch found here:
113# http://marc.theaimsgroup.com/?l=git&m=111558757202243&w=2
114#
115# Until that version is released you may have to apply the patch
116# yourself - yes, all 6 characters of it!
117#
118
bb230097
CJ
119QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir
120QUIET_SUBDIR1 =
121
122ifneq ($(findstring $(MAKEFLAGS),w),w)
123PRINT_DIR = --no-print-directory
124else # "make -w"
125NO_SUBDIR = :
126endif
127
128ifneq ($(findstring $(MAKEFLAGS),s),s)
129ifndef V
130 QUIET_ASCIIDOC = @echo ' ' ASCIIDOC $@;
131 QUIET_XMLTO = @echo ' ' XMLTO $@;
132 QUIET_DB2TEXI = @echo ' ' DB2TEXI $@;
133 QUIET_MAKEINFO = @echo ' ' MAKEINFO $@;
134 QUIET_DBLATEX = @echo ' ' DBLATEX $@;
135 QUIET_XSLTPROC = @echo ' ' XSLTPROC $@;
136 QUIET_GEN = @echo ' ' GEN $@;
137 QUIET_STDERR = 2> /dev/null
138 QUIET_SUBDIR0 = +@subdir=
139 QUIET_SUBDIR1 = ;$(NO_SUBDIR) echo ' ' SUBDIR $$subdir; \
140 $(MAKE) $(PRINT_DIR) -C $$subdir
141 export V
142endif
143endif
144
b2bf34d6 145all: html man
b790abb8
DG
146
147html: $(DOC_HTML)
148
4392da4d 149$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
b2bf34d6 150
4392da4d 151man: man1 man5 man7
b2bf34d6 152man1: $(DOC_MAN1)
4392da4d 153man5: $(DOC_MAN5)
b2bf34d6 154man7: $(DOC_MAN7)
b790abb8 155
5cefc33b 156info: git.info gitman.info
4739809c 157
a325a1a7
MV
158pdf: user-manual.pdf
159
b1a46b70
MH
160install: install-man
161
162install-man: man
41650765
RS
163 $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
164 $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
165 $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
166 $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
167 $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
168 $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
87a81c83 169
4739809c 170install-info: info
41650765 171 $(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
5cefc33b 172 $(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
4739809c
DK
173 if test -r $(DESTDIR)$(infodir)/dir; then \
174 $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
5cefc33b 175 $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
4739809c
DK
176 else \
177 echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
178 fi
37465016 179
a325a1a7
MV
180install-pdf: pdf
181 $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
182 $(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)
183
5d6491c7 184install-html: html
ee7ec2f9 185 '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
5d6491c7 186
7b8a74f3 187../GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
bb230097 188 $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
7b8a74f3
FL
189
190-include ../GIT-VERSION-FILE
191
93d69d86
JL
192#
193# Determine "include::" file references in asciidoc files.
194#
fb612d54 195doc.dep : $(wildcard *.txt) build-docdep.perl
bb230097
CJ
196 $(QUIET_GEN)$(RM) $@+ $@ && \
197 $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
a5ae8e64 198 mv $@+ $@
93d69d86 199
a5ae8e64 200-include doc.dep
37465016 201
72fe6a59
JH
202cmds_txt = cmds-ancillaryinterrogators.txt \
203 cmds-ancillarymanipulators.txt \
204 cmds-mainporcelain.txt \
205 cmds-plumbinginterrogators.txt \
206 cmds-plumbingmanipulators.txt \
89bf2077
JH
207 cmds-synchingrepositories.txt \
208 cmds-synchelpers.txt \
209 cmds-purehelpers.txt \
210 cmds-foreignscminterface.txt
72fe6a59 211
d7907392
JH
212$(cmds_txt): cmd-list.made
213
79d30668 214cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
bb230097
CJ
215 $(QUIET_GEN)$(RM) $@ && \
216 $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
d7907392 217 date >$@
b790abb8
DG
218
219clean:
4c785e50 220 $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
c6a5ad21 221 $(RM) *.texi *.texi+ *.texi++ git.info gitman.info
530e741c
JH
222 $(RM) howto-index.txt howto/*.html doc.dep
223 $(RM) technical/api-*.html technical/api-index.txt
4cb08df5 224 $(RM) $(cmds_txt) *.made
b790abb8 225
530e741c 226$(MAN_HTML): %.html : %.txt
bb230097 227 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
7b8a74f3 228 $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
bb230097 229 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
7b8a74f3 230 mv $@+ $@
b790abb8 231
4392da4d 232%.1 %.5 %.7 : %.xml
bb230097 233 $(QUIET_XMLTO)$(RM) $@ && \
5121a6d9 234 xmlto -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
b790abb8
DG
235
236%.xml : %.txt
bb230097 237 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
7b8a74f3 238 $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
bb230097 239 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
7b8a74f3 240 mv $@+ $@
3f971fc4 241
d19fbc3c 242user-manual.xml: user-manual.txt user-manual.conf
26e47f25 243 $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d book $<
d19fbc3c 244
530e741c
JH
245technical/api-index.txt: technical/api-index-skel.txt \
246 technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
ee7ec2f9 247 $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh
530e741c
JH
248
249$(patsubst %,%.html,$(API_DOCS) technical/api-index): %.html : %.txt
bb230097 250 $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
530e741c
JH
251 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
252
1cffddd6 253XSLT = docbook.xsl
0a3985dc 254XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
1c95c565 255
d19fbc3c 256user-manual.html: user-manual.xml
bb230097 257 $(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
d19fbc3c 258
50b3555c 259git.info: user-manual.texi
bb230097 260 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
5cefc33b 261
50b3555c 262user-manual.texi: user-manual.xml
bb230097 263 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
c6a5ad21
CJ
264 $(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
265 $(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
266 rm $@++ && \
5cefc33b
JH
267 mv $@+ $@
268
a325a1a7 269user-manual.pdf: user-manual.xml
bb230097
CJ
270 $(QUIET_DBLATEX)$(RM) $@+ $@ && \
271 $(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $< && \
a325a1a7
MV
272 mv $@+ $@
273
5cefc33b 274gitman.texi: $(MAN_XML) cat-texi.perl
bb230097 275 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
8b30ad01 276 ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
c6a5ad21
CJ
277 --to-stdout $(xml) &&) true) > $@++ && \
278 $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
279 rm $@++ && \
5cefc33b
JH
280 mv $@+ $@
281
282gitman.info: gitman.texi
bb230097 283 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
5cefc33b
JH
284
285$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
bb230097
CJ
286 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
287 $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
5cefc33b 288 mv $@+ $@
4739809c 289
e6fc2346 290howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
bb230097 291 $(QUIET_GEN)$(RM) $@+ $@ && \
ee7ec2f9 292 '$(SHELL_PATH_SQ)' ./howto-index.sh $(wildcard howto/*.txt) >$@+ && \
e6fc2346
JH
293 mv $@+ $@
294
8db9307c 295$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
26e47f25 296 $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 $*.txt
e6fc2346
JH
297
298WEBDOC_DEST = /pub/software/scm/git/docs
299
8d0991d7 300$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
bb230097 301 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
26e47f25 302 sed -e '1,/^$$/d' $< | $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 - >$@+ && \
8d0991d7
JH
303 mv $@+ $@
304
e6fc2346 305install-webdoc : html
ee7ec2f9 306 '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
6538d1ef 307
b1a46b70
MH
308quick-install: quick-install-man
309
310quick-install-man:
ee7ec2f9 311 '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)
7b8a74f3 312
6fe570de 313quick-install-html:
ee7ec2f9 314 '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REF) $(DESTDIR)$(htmldir)
6fe570de 315
7b8a74f3 316.PHONY: .FORCE-GIT-VERSION-FILE