Merge branch 'js/completion-hide-not-a-repo'
[git] / Documentation / Makefile
1 # Guard against environment variables
2 MAN1_TXT =
3 MAN5_TXT =
4 MAN7_TXT =
5 TECH_DOCS =
6 ARTICLES =
7 SP_ARTICLES =
8 OBSOLETE_HTML =
9
10 MAN1_TXT += $(filter-out \
11                 $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
12                 $(wildcard git-*.txt))
13 MAN1_TXT += git.txt
14 MAN1_TXT += gitk.txt
15 MAN1_TXT += gitremote-helpers.txt
16 MAN1_TXT += gitweb.txt
17
18 MAN5_TXT += gitattributes.txt
19 MAN5_TXT += githooks.txt
20 MAN5_TXT += gitignore.txt
21 MAN5_TXT += gitmodules.txt
22 MAN5_TXT += gitrepository-layout.txt
23 MAN5_TXT += gitweb.conf.txt
24
25 MAN7_TXT += gitcli.txt
26 MAN7_TXT += gitcore-tutorial.txt
27 MAN7_TXT += gitcredentials.txt
28 MAN7_TXT += gitcvs-migration.txt
29 MAN7_TXT += gitdiffcore.txt
30 MAN7_TXT += giteveryday.txt
31 MAN7_TXT += gitglossary.txt
32 MAN7_TXT += gitnamespaces.txt
33 MAN7_TXT += gitrevisions.txt
34 MAN7_TXT += gittutorial-2.txt
35 MAN7_TXT += gittutorial.txt
36 MAN7_TXT += gitworkflows.txt
37
38 MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
39 MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
40 MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT))
41
42 OBSOLETE_HTML += everyday.html
43 OBSOLETE_HTML += git-remote-helpers.html
44 DOC_HTML = $(MAN_HTML) $(OBSOLETE_HTML)
45
46 ARTICLES += howto-index
47 ARTICLES += git-tools
48 ARTICLES += git-bisect-lk2009
49 # with their own formatting rules.
50 SP_ARTICLES += user-manual
51 SP_ARTICLES += howto/new-command
52 SP_ARTICLES += howto/revert-branch-rebase
53 SP_ARTICLES += howto/using-merge-subtree
54 SP_ARTICLES += howto/using-signed-tag-in-pull-request
55 SP_ARTICLES += howto/use-git-daemon
56 SP_ARTICLES += howto/update-hook-example
57 SP_ARTICLES += howto/setup-git-server-over-http
58 SP_ARTICLES += howto/separating-topic-branches
59 SP_ARTICLES += howto/revert-a-faulty-merge
60 SP_ARTICLES += howto/recover-corrupted-blob-object
61 SP_ARTICLES += howto/recover-corrupted-object-harder
62 SP_ARTICLES += howto/rebuild-from-update-hook
63 SP_ARTICLES += howto/rebase-from-internal-branch
64 SP_ARTICLES += howto/keep-canonical-history-correct
65 SP_ARTICLES += howto/maintain-git
66 API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
67 SP_ARTICLES += $(API_DOCS)
68
69 TECH_DOCS += technical/http-protocol
70 TECH_DOCS += technical/index-format
71 TECH_DOCS += technical/pack-format
72 TECH_DOCS += technical/pack-heuristics
73 TECH_DOCS += technical/pack-protocol
74 TECH_DOCS += technical/protocol-capabilities
75 TECH_DOCS += technical/protocol-common
76 TECH_DOCS += technical/racy-git
77 TECH_DOCS += technical/send-pack-pipeline
78 TECH_DOCS += technical/shallow
79 TECH_DOCS += technical/trivial-merge
80 SP_ARTICLES += $(TECH_DOCS)
81 SP_ARTICLES += technical/api-index
82
83 DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
84
85 DOC_MAN1 = $(patsubst %.txt,%.1,$(MAN1_TXT))
86 DOC_MAN5 = $(patsubst %.txt,%.5,$(MAN5_TXT))
87 DOC_MAN7 = $(patsubst %.txt,%.7,$(MAN7_TXT))
88
89 prefix ?= $(HOME)
90 bindir ?= $(prefix)/bin
91 htmldir ?= $(prefix)/share/doc/git-doc
92 infodir ?= $(prefix)/share/info
93 pdfdir ?= $(prefix)/share/doc/git-doc
94 mandir ?= $(prefix)/share/man
95 man1dir = $(mandir)/man1
96 man5dir = $(mandir)/man5
97 man7dir = $(mandir)/man7
98 # DESTDIR =
99
100 ASCIIDOC = asciidoc
101 ASCIIDOC_EXTRA =
102 MANPAGE_XSL = manpage-normal.xsl
103 XMLTO = xmlto
104 XMLTO_EXTRA =
105 INSTALL ?= install
106 RM ?= rm -f
107 MAN_REPO = ../../git-manpages
108 HTML_REPO = ../../git-htmldocs
109
110 MAKEINFO = makeinfo
111 INSTALL_INFO = install-info
112 DOCBOOK2X_TEXI = docbook2x-texi
113 DBLATEX = dblatex
114 ASCIIDOC_DBLATEX_DIR = /etc/asciidoc/dblatex
115 ifndef PERL_PATH
116         PERL_PATH = /usr/bin/perl
117 endif
118
119 -include ../config.mak.autogen
120 -include ../config.mak
121
122 #
123 # For docbook-xsl ...
124 #       -1.68.1,        no extra settings are needed?
125 #       1.69.0,         set ASCIIDOC_ROFF?
126 #       1.69.1-1.71.0,  set DOCBOOK_SUPPRESS_SP?
127 #       1.71.1,         set ASCIIDOC_ROFF?
128 #       1.72.0,         set DOCBOOK_XSL_172.
129 #       1.73.0-,        no extra settings are needed
130 #
131
132 ifdef DOCBOOK_XSL_172
133 ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
134 MANPAGE_XSL = manpage-1.72.xsl
135 else
136         ifndef ASCIIDOC_ROFF
137         # docbook-xsl after 1.72 needs the regular XSL, but will not
138         # pass-thru raw roff codes from asciidoc.conf, so turn them off.
139         ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
140         endif
141 endif
142 ifdef MAN_BOLD_LITERAL
143 XMLTO_EXTRA += -m manpage-bold-literal.xsl
144 endif
145 ifdef DOCBOOK_SUPPRESS_SP
146 XMLTO_EXTRA += -m manpage-suppress-sp.xsl
147 endif
148
149 # Newer DocBook stylesheet emits warning cruft in the output when
150 # this is not set, and if set it shows an absolute link.  Older
151 # stylesheets simply ignore this parameter.
152 #
153 # Distros may want to use MAN_BASE_URL=file:///path/to/git/docs/
154 # or similar.
155 ifndef MAN_BASE_URL
156 MAN_BASE_URL = file://$(htmldir)/
157 endif
158 XMLTO_EXTRA += -m manpage-base-url.xsl
159
160 # If your target system uses GNU groff, it may try to render
161 # apostrophes as a "pretty" apostrophe using unicode.  This breaks
162 # cut&paste, so you should set GNU_ROFF to force them to be ASCII
163 # apostrophes.  Unfortunately does not work with non-GNU roff.
164 ifdef GNU_ROFF
165 XMLTO_EXTRA += -m manpage-quote-apos.xsl
166 endif
167
168 SHELL_PATH ?= $(SHELL)
169 # Shell quote;
170 SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
171
172 ifdef DEFAULT_PAGER
173 DEFAULT_PAGER_SQ = $(subst ','\'',$(DEFAULT_PAGER))
174 ASCIIDOC_EXTRA += -a 'git-default-pager=$(DEFAULT_PAGER_SQ)'
175 endif
176
177 ifdef DEFAULT_EDITOR
178 DEFAULT_EDITOR_SQ = $(subst ','\'',$(DEFAULT_EDITOR))
179 ASCIIDOC_EXTRA += -a 'git-default-editor=$(DEFAULT_EDITOR_SQ)'
180 endif
181
182 QUIET_SUBDIR0  = +$(MAKE) -C # space to separate -C and subdir
183 QUIET_SUBDIR1  =
184
185 ifneq ($(findstring $(MAKEFLAGS),w),w)
186 PRINT_DIR = --no-print-directory
187 else # "make -w"
188 NO_SUBDIR = :
189 endif
190
191 ifneq ($(findstring $(MAKEFLAGS),s),s)
192 ifndef V
193         QUIET_ASCIIDOC  = @echo '   ' ASCIIDOC $@;
194         QUIET_XMLTO     = @echo '   ' XMLTO $@;
195         QUIET_DB2TEXI   = @echo '   ' DB2TEXI $@;
196         QUIET_MAKEINFO  = @echo '   ' MAKEINFO $@;
197         QUIET_DBLATEX   = @echo '   ' DBLATEX $@;
198         QUIET_XSLTPROC  = @echo '   ' XSLTPROC $@;
199         QUIET_GEN       = @echo '   ' GEN $@;
200         QUIET_STDERR    = 2> /dev/null
201         QUIET_SUBDIR0   = +@subdir=
202         QUIET_SUBDIR1   = ;$(NO_SUBDIR) echo '   ' SUBDIR $$subdir; \
203                           $(MAKE) $(PRINT_DIR) -C $$subdir
204         export V
205 endif
206 endif
207
208 all: html man
209
210 html: $(DOC_HTML)
211
212 man: man1 man5 man7
213 man1: $(DOC_MAN1)
214 man5: $(DOC_MAN5)
215 man7: $(DOC_MAN7)
216
217 info: git.info gitman.info
218
219 pdf: user-manual.pdf
220
221 install: install-man
222
223 install-man: man
224         $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
225         $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
226         $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
227         $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
228         $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
229         $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
230
231 install-info: info
232         $(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
233         $(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
234         if test -r $(DESTDIR)$(infodir)/dir; then \
235           $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
236           $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
237         else \
238           echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
239         fi
240
241 install-pdf: pdf
242         $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
243         $(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)
244
245 install-html: html
246         '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
247
248 ../GIT-VERSION-FILE: FORCE
249         $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
250
251 -include ../GIT-VERSION-FILE
252
253 #
254 # Determine "include::" file references in asciidoc files.
255 #
256 docdep_prereqs = \
257         mergetools-list.made $(mergetools_txt) \
258         cmd-list.made $(cmds_txt)
259
260 doc.dep : $(docdep_prereqs) $(wildcard *.txt) build-docdep.perl
261         $(QUIET_GEN)$(RM) $@+ $@ && \
262         $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
263         mv $@+ $@
264
265 -include doc.dep
266
267 cmds_txt = cmds-ancillaryinterrogators.txt \
268         cmds-ancillarymanipulators.txt \
269         cmds-mainporcelain.txt \
270         cmds-plumbinginterrogators.txt \
271         cmds-plumbingmanipulators.txt \
272         cmds-synchingrepositories.txt \
273         cmds-synchelpers.txt \
274         cmds-purehelpers.txt \
275         cmds-foreignscminterface.txt
276
277 $(cmds_txt): cmd-list.made
278
279 cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
280         $(QUIET_GEN)$(RM) $@ && \
281         $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
282         date >$@
283
284 mergetools_txt = mergetools-diff.txt mergetools-merge.txt
285
286 $(mergetools_txt): mergetools-list.made
287
288 mergetools-list.made: ../git-mergetool--lib.sh $(wildcard ../mergetools/*)
289         $(QUIET_GEN)$(RM) $@ && \
290         $(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
291                 . ../git-mergetool--lib.sh && \
292                 show_tool_names can_diff "* " || :' >mergetools-diff.txt && \
293         $(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
294                 . ../git-mergetool--lib.sh && \
295                 show_tool_names can_merge "* " || :' >mergetools-merge.txt && \
296         date >$@
297
298 clean:
299         $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
300         $(RM) *.texi *.texi+ *.texi++ git.info gitman.info
301         $(RM) *.pdf
302         $(RM) howto-index.txt howto/*.html doc.dep
303         $(RM) technical/*.html technical/api-index.txt
304         $(RM) $(cmds_txt) $(mergetools_txt) *.made
305         $(RM) manpage-base-url.xsl
306
307 $(MAN_HTML): %.html : %.txt asciidoc.conf
308         $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
309         $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
310                 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
311         mv $@+ $@
312
313 $(OBSOLETE_HTML): %.html : %.txto asciidoc.conf
314         $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
315         $(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
316                 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
317         mv $@+ $@
318
319 manpage-base-url.xsl: manpage-base-url.xsl.in
320         sed "s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|" $< > $@
321
322 %.1 %.5 %.7 : %.xml manpage-base-url.xsl
323         $(QUIET_XMLTO)$(RM) $@ && \
324         $(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
325
326 %.xml : %.txt asciidoc.conf
327         $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
328         $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
329                 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
330         mv $@+ $@
331
332 user-manual.xml: user-manual.txt user-manual.conf
333         $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
334         $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d article -o $@+ $< && \
335         mv $@+ $@
336
337 technical/api-index.txt: technical/api-index-skel.txt \
338         technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
339         $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh
340
341 technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
342 $(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
345
346 XSLT = docbook.xsl
347 XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
348
349 user-manual.html: user-manual.xml $(XSLT)
350         $(QUIET_XSLTPROC)$(RM) $@+ $@ && \
351         xsltproc $(XSLTOPTS) -o $@+ $(XSLT) $< && \
352         mv $@+ $@
353
354 git.info: user-manual.texi
355         $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
356
357 user-manual.texi: user-manual.xml
358         $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
359         $(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
360         $(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
361         rm $@++ && \
362         mv $@+ $@
363
364 user-manual.pdf: user-manual.xml
365         $(QUIET_DBLATEX)$(RM) $@+ $@ && \
366         $(DBLATEX) -o $@+ -p $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.xsl -s $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.sty $< && \
367         mv $@+ $@
368
369 gitman.texi: $(MAN_XML) cat-texi.perl
370         $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
371         ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
372                 --to-stdout $(xml) &&) true) > $@++ && \
373         $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
374         rm $@++ && \
375         mv $@+ $@
376
377 gitman.info: gitman.texi
378         $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
379
380 $(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
381         $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
382         $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
383         mv $@+ $@
384
385 howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
386         $(QUIET_GEN)$(RM) $@+ $@ && \
387         '$(SHELL_PATH_SQ)' ./howto-index.sh $(sort $(wildcard howto/*.txt)) >$@+ && \
388         mv $@+ $@
389
390 $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
391         $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 $*.txt
392
393 WEBDOC_DEST = /pub/software/scm/git/docs
394
395 howto/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
396 $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
397         $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
398         sed -e '1,/^$$/d' $< | $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 - >$@+ && \
399         mv $@+ $@
400
401 install-webdoc : html
402         '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
403
404 # You must have a clone of 'git-htmldocs' and 'git-manpages' repositories
405 # next to the 'git' repository itself for the following to work.
406
407 quick-install: quick-install-man
408
409 require-manrepo::
410         @if test ! -d $(MAN_REPO); \
411         then echo "git-manpages repository must exist at $(MAN_REPO)"; exit 1; fi
412
413 quick-install-man: require-manrepo
414         '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(MAN_REPO) $(DESTDIR)$(mandir)
415
416 require-htmlrepo::
417         @if test ! -d $(HTML_REPO); \
418         then echo "git-htmldocs repository must exist at $(HTML_REPO)"; exit 1; fi
419
420 quick-install-html: require-htmlrepo
421         '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REPO) $(DESTDIR)$(htmldir)
422
423 print-man1:
424         @for i in $(MAN1_TXT); do echo $$i; done
425
426 .PHONY: FORCE