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