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