1 # Guard against environment variables
10 -include GIT-EXCLUDED-PROGRAMS
12 MAN1_TXT += $(filter-out \
13 $(patsubst %,%.txt,$(EXCLUDED_PROGRAMS)) \
14 $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
15 $(wildcard git-*.txt))
18 MAN1_TXT += gitweb.txt
20 MAN5_TXT += gitattributes.txt
21 MAN5_TXT += githooks.txt
22 MAN5_TXT += gitignore.txt
23 MAN5_TXT += gitmodules.txt
24 MAN5_TXT += gitrepository-layout.txt
25 MAN5_TXT += gitweb.conf.txt
27 MAN7_TXT += gitcli.txt
28 MAN7_TXT += gitcore-tutorial.txt
29 MAN7_TXT += gitcredentials.txt
30 MAN7_TXT += gitcvs-migration.txt
31 MAN7_TXT += gitdiffcore.txt
32 MAN7_TXT += giteveryday.txt
33 MAN7_TXT += gitglossary.txt
34 MAN7_TXT += gitnamespaces.txt
35 MAN7_TXT += gitremote-helpers.txt
36 MAN7_TXT += gitrevisions.txt
37 MAN7_TXT += gitsubmodules.txt
38 MAN7_TXT += gittutorial-2.txt
39 MAN7_TXT += gittutorial.txt
40 MAN7_TXT += gitworkflows.txt
43 MAN_TXT = $(filter $(MAN_FILTER),$(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT))
45 MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
46 MAN_FILTER = $(MAN_TXT)
49 MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
50 MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT))
53 OBSOLETE_HTML += everyday.html
54 OBSOLETE_HTML += git-remote-helpers.html
56 ARTICLES += howto-index
58 ARTICLES += git-bisect-lk2009
59 # with their own formatting rules.
60 SP_ARTICLES += user-manual
61 SP_ARTICLES += howto/new-command
62 SP_ARTICLES += howto/revert-branch-rebase
63 SP_ARTICLES += howto/using-merge-subtree
64 SP_ARTICLES += howto/using-signed-tag-in-pull-request
65 SP_ARTICLES += howto/use-git-daemon
66 SP_ARTICLES += howto/update-hook-example
67 SP_ARTICLES += howto/setup-git-server-over-http
68 SP_ARTICLES += howto/separating-topic-branches
69 SP_ARTICLES += howto/revert-a-faulty-merge
70 SP_ARTICLES += howto/recover-corrupted-blob-object
71 SP_ARTICLES += howto/recover-corrupted-object-harder
72 SP_ARTICLES += howto/rebuild-from-update-hook
73 SP_ARTICLES += howto/rebase-from-internal-branch
74 SP_ARTICLES += howto/keep-canonical-history-correct
75 SP_ARTICLES += howto/maintain-git
76 API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
77 SP_ARTICLES += $(API_DOCS)
79 TECH_DOCS += MyFirstContribution
80 TECH_DOCS += MyFirstObjectWalk
81 TECH_DOCS += SubmittingPatches
82 TECH_DOCS += technical/hash-function-transition
83 TECH_DOCS += technical/http-protocol
84 TECH_DOCS += technical/index-format
85 TECH_DOCS += technical/long-running-process-protocol
86 TECH_DOCS += technical/multi-pack-index
87 TECH_DOCS += technical/pack-format
88 TECH_DOCS += technical/pack-heuristics
89 TECH_DOCS += technical/pack-protocol
90 TECH_DOCS += technical/partial-clone
91 TECH_DOCS += technical/protocol-capabilities
92 TECH_DOCS += technical/protocol-common
93 TECH_DOCS += technical/protocol-v2
94 TECH_DOCS += technical/racy-git
95 TECH_DOCS += technical/send-pack-pipeline
96 TECH_DOCS += technical/shallow
97 TECH_DOCS += technical/signature-format
98 TECH_DOCS += technical/trivial-merge
99 SP_ARTICLES += $(TECH_DOCS)
100 SP_ARTICLES += technical/api-index
102 ARTICLES_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
103 HTML_FILTER ?= $(ARTICLES_HTML) $(OBSOLETE_HTML)
104 DOC_HTML = $(MAN_HTML) $(filter $(HTML_FILTER),$(ARTICLES_HTML) $(OBSOLETE_HTML))
106 DOC_MAN1 = $(patsubst %.txt,%.1,$(filter $(MAN_FILTER),$(MAN1_TXT)))
107 DOC_MAN5 = $(patsubst %.txt,%.5,$(filter $(MAN_FILTER),$(MAN5_TXT)))
108 DOC_MAN7 = $(patsubst %.txt,%.7,$(filter $(MAN_FILTER),$(MAN7_TXT)))
111 bindir ?= $(prefix)/bin
112 htmldir ?= $(prefix)/share/doc/git-doc
113 infodir ?= $(prefix)/share/info
114 pdfdir ?= $(prefix)/share/doc/git-doc
115 mandir ?= $(prefix)/share/man
116 man1dir = $(mandir)/man1
117 man5dir = $(mandir)/man5
118 man7dir = $(mandir)/man7
123 ASCIIDOC_HTML = xhtml11
124 ASCIIDOC_DOCBOOK = docbook
125 ASCIIDOC_CONF = -f asciidoc.conf
126 ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF) \
127 -amanversion=$(GIT_VERSION) \
128 -amanmanual='Git Manual' -amansource='Git'
129 TXT_TO_HTML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_HTML)
130 TXT_TO_XML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_DOCBOOK)
131 MANPAGE_XSL = manpage-normal.xsl
136 MAN_REPO = ../../git-manpages
137 HTML_REPO = ../../git-htmldocs
140 INSTALL_INFO = install-info
141 DOCBOOK2X_TEXI = docbook2x-texi
143 ASCIIDOC_DBLATEX_DIR = /etc/asciidoc/dblatex
144 DBLATEX_COMMON = -p $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.xsl -s $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.sty
146 PERL_PATH = /usr/bin/perl
149 -include ../config.mak.autogen
150 -include ../config.mak
153 # For docbook-xsl ...
154 # -1.68.1, no extra settings are needed?
155 # 1.69.0, set ASCIIDOC_ROFF?
156 # 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP?
157 # 1.71.1, set ASCIIDOC_ROFF?
158 # 1.72.0, set DOCBOOK_XSL_172.
159 # 1.73.0-, no extra settings are needed
162 ifdef DOCBOOK_XSL_172
163 ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
164 MANPAGE_XSL = manpage-1.72.xsl
167 # docbook-xsl after 1.72 needs the regular XSL, but will not
168 # pass-thru raw roff codes from asciidoc.conf, so turn them off.
169 ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
172 ifndef NO_MAN_BOLD_LITERAL
173 XMLTO_EXTRA += -m manpage-bold-literal.xsl
175 ifdef DOCBOOK_SUPPRESS_SP
176 XMLTO_EXTRA += -m manpage-suppress-sp.xsl
179 # Newer DocBook stylesheet emits warning cruft in the output when
180 # this is not set, and if set it shows an absolute link. Older
181 # stylesheets simply ignore this parameter.
183 # Distros may want to use MAN_BASE_URL=file:///path/to/git/docs/
186 MAN_BASE_URL = file://$(htmldir)/
188 XMLTO_EXTRA += -m manpage-base-url.xsl
190 # If your target system uses GNU groff, it may try to render
191 # apostrophes as a "pretty" apostrophe using unicode. This breaks
192 # cut&paste, so you should set GNU_ROFF to force them to be ASCII
193 # apostrophes. Unfortunately does not work with non-GNU roff.
195 XMLTO_EXTRA += -m manpage-quote-apos.xsl
198 ifdef USE_ASCIIDOCTOR
199 ASCIIDOC = asciidoctor
201 ASCIIDOC_HTML = xhtml5
202 ASCIIDOC_DOCBOOK = docbook5
203 ASCIIDOC_EXTRA += -acompat-mode -atabsize=8
204 ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions
205 ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;'
207 XMLTO_EXTRA += --skip-validation
208 XMLTO_EXTRA += -x manpage.xsl
211 SHELL_PATH ?= $(SHELL)
213 SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
216 DEFAULT_PAGER_SQ = $(subst ','\'',$(DEFAULT_PAGER))
217 ASCIIDOC_EXTRA += -a 'git-default-pager=$(DEFAULT_PAGER_SQ)'
221 DEFAULT_EDITOR_SQ = $(subst ','\'',$(DEFAULT_EDITOR))
222 ASCIIDOC_EXTRA += -a 'git-default-editor=$(DEFAULT_EDITOR_SQ)'
225 QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir
228 ifneq ($(findstring $(MAKEFLAGS),w),w)
229 PRINT_DIR = --no-print-directory
234 ifneq ($(findstring $(MAKEFLAGS),s),s)
236 QUIET_ASCIIDOC = @echo ' ' ASCIIDOC $@;
237 QUIET_XMLTO = @echo ' ' XMLTO $@;
238 QUIET_DB2TEXI = @echo ' ' DB2TEXI $@;
239 QUIET_MAKEINFO = @echo ' ' MAKEINFO $@;
240 QUIET_DBLATEX = @echo ' ' DBLATEX $@;
241 QUIET_XSLTPROC = @echo ' ' XSLTPROC $@;
242 QUIET_GEN = @echo ' ' GEN $@;
243 QUIET_LINT = @echo ' ' LINT $@;
244 QUIET_STDERR = 2> /dev/null
245 QUIET_SUBDIR0 = +@subdir=
246 QUIET_SUBDIR1 = ;$(NO_SUBDIR) echo ' ' SUBDIR $$subdir; \
247 $(MAKE) $(PRINT_DIR) -C $$subdir
261 info: git.info gitman.info
268 $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
269 $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
270 $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
271 $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
272 $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
273 $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
276 $(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
277 $(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
278 if test -r $(DESTDIR)$(infodir)/dir; then \
279 $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
280 $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
282 echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
286 $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
287 $(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)
290 '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
292 ../GIT-VERSION-FILE: FORCE
293 $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
295 -include ../GIT-VERSION-FILE
298 # Determine "include::" file references in asciidoc files.
301 mergetools-list.made $(mergetools_txt) \
302 cmd-list.made $(cmds_txt)
304 doc.dep : $(docdep_prereqs) $(wildcard *.txt) $(wildcard config/*.txt) build-docdep.perl
305 $(QUIET_GEN)$(RM) $@+ $@ && \
306 $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
311 cmds_txt = cmds-ancillaryinterrogators.txt \
312 cmds-ancillarymanipulators.txt \
313 cmds-mainporcelain.txt \
314 cmds-plumbinginterrogators.txt \
315 cmds-plumbingmanipulators.txt \
316 cmds-synchingrepositories.txt \
317 cmds-synchelpers.txt \
318 cmds-purehelpers.txt \
319 cmds-foreignscminterface.txt
321 $(cmds_txt): cmd-list.made
323 cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
324 $(QUIET_GEN)$(RM) $@ && \
325 $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
328 mergetools_txt = mergetools-diff.txt mergetools-merge.txt
330 $(mergetools_txt): mergetools-list.made
332 mergetools-list.made: ../git-mergetool--lib.sh $(wildcard ../mergetools/*)
333 $(QUIET_GEN)$(RM) $@ && \
334 $(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
335 . ../git-mergetool--lib.sh && \
336 show_tool_names can_diff "* " || :' >mergetools-diff.txt && \
337 $(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
338 . ../git-mergetool--lib.sh && \
339 show_tool_names can_merge "* " || :' >mergetools-merge.txt && \
342 TRACK_ASCIIDOCFLAGS = $(subst ','\'',$(ASCIIDOC_COMMON):$(ASCIIDOC_HTML):$(ASCIIDOC_DOCBOOK))
344 GIT-ASCIIDOCFLAGS: FORCE
345 @FLAGS='$(TRACK_ASCIIDOCFLAGS)'; \
346 if test x"$$FLAGS" != x"`cat GIT-ASCIIDOCFLAGS 2>/dev/null`" ; then \
347 echo >&2 " * new asciidoc flags"; \
348 echo "$$FLAGS" >GIT-ASCIIDOCFLAGS; \
352 $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
353 $(RM) *.texi *.texi+ *.texi++ git.info gitman.info
355 $(RM) howto-index.txt howto/*.html doc.dep
356 $(RM) technical/*.html technical/api-index.txt
357 $(RM) SubmittingPatches.txt
358 $(RM) $(cmds_txt) $(mergetools_txt) *.made
359 $(RM) manpage-base-url.xsl
360 $(RM) GIT-ASCIIDOCFLAGS
362 $(MAN_HTML): %.html : %.txt asciidoc.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
363 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
364 $(TXT_TO_HTML) -d manpage -o $@+ $< && \
367 $(OBSOLETE_HTML): %.html : %.txto asciidoc.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
368 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
369 $(TXT_TO_HTML) -o $@+ $< && \
372 manpage-base-url.xsl: manpage-base-url.xsl.in
373 $(QUIET_GEN)sed "s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|" $< > $@
375 %.1 %.5 %.7 : %.xml manpage-base-url.xsl $(wildcard manpage*.xsl)
376 $(QUIET_XMLTO)$(RM) $@ && \
377 $(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
379 %.xml : %.txt asciidoc.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
380 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
381 $(TXT_TO_XML) -d manpage -o $@+ $< && \
384 user-manual.xml: user-manual.txt user-manual.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
385 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
386 $(TXT_TO_XML) -d book -o $@+ $< && \
389 technical/api-index.txt: technical/api-index-skel.txt \
390 technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
391 $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh
393 technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
394 $(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt \
395 asciidoc.conf GIT-ASCIIDOCFLAGS
396 $(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt
398 SubmittingPatches.txt: SubmittingPatches
399 $(QUIET_GEN) cp $< $@
402 XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
404 user-manual.html: user-manual.xml $(XSLT)
405 $(QUIET_XSLTPROC)$(RM) $@+ $@ && \
406 xsltproc $(XSLTOPTS) -o $@+ $(XSLT) $< && \
409 git.info: user-manual.texi
410 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
412 user-manual.texi: user-manual.xml
413 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
414 $(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
415 $(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
419 user-manual.pdf: user-manual.xml
420 $(QUIET_DBLATEX)$(RM) $@+ $@ && \
421 $(DBLATEX) -o $@+ $(DBLATEX_COMMON) $< && \
424 gitman.texi: $(MAN_XML) cat-texi.perl texi.xsl
425 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
426 ($(foreach xml,$(sort $(MAN_XML)),xsltproc -o $(xml)+ texi.xsl $(xml) && \
427 $(DOCBOOK2X_TEXI) --encoding=UTF-8 --to-stdout $(xml)+ && \
428 rm $(xml)+ &&) true) > $@++ && \
429 $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
433 gitman.info: gitman.texi
434 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
436 $(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
437 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
438 $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
441 howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
442 $(QUIET_GEN)$(RM) $@+ $@ && \
443 '$(SHELL_PATH_SQ)' ./howto-index.sh $(sort $(wildcard howto/*.txt)) >$@+ && \
446 $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
447 $(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt
449 WEBDOC_DEST = /pub/software/scm/git/docs
451 howto/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
452 $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt GIT-ASCIIDOCFLAGS
453 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
454 sed -e '1,/^$$/d' $< | \
455 $(TXT_TO_HTML) - >$@+ && \
458 install-webdoc : html
459 '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
461 # You must have a clone of 'git-htmldocs' and 'git-manpages' repositories
462 # next to the 'git' repository itself for the following to work.
464 quick-install: quick-install-man
467 @if test ! -d $(MAN_REPO); \
468 then echo "git-manpages repository must exist at $(MAN_REPO)"; exit 1; fi
470 quick-install-man: require-manrepo
471 '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(MAN_REPO) $(DESTDIR)$(mandir) $(GIT_MAN_REF)
474 @if test ! -d $(HTML_REPO); \
475 then echo "git-htmldocs repository must exist at $(HTML_REPO)"; exit 1; fi
477 quick-install-html: require-htmlrepo
478 '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REPO) $(DESTDIR)$(htmldir) $(GIT_MAN_REF)
481 @for i in $(MAN1_TXT); do echo $$i; done
484 $(QUIET_LINT)$(PERL_PATH) lint-gitlink.perl
486 ifeq ($(wildcard po/Makefile),po/Makefile)
487 doc-l10n install-l10n::