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