Merge branch 'master' of https://github.com/vnwildman/git
[git.git] / Documentation / Makefile
blob76f2ecfc1b1a42c601542928847fd79890e4d96c
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 =
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))
16 MAN1_TXT += git.txt
17 MAN1_TXT += gitk.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
42 ifdef MAN_FILTER
43 MAN_TXT = $(filter $(MAN_FILTER),$(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT))
44 else
45 MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
46 MAN_FILTER = $(MAN_TXT)
47 endif
49 MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
50 MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT))
51 GIT_MAN_REF = master
53 OBSOLETE_HTML += everyday.html
54 OBSOLETE_HTML += git-remote-helpers.html
56 ARTICLES += howto-index
57 ARTICLES += git-tools
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 += SubmittingPatches
81 TECH_DOCS += technical/hash-function-transition
82 TECH_DOCS += technical/http-protocol
83 TECH_DOCS += technical/index-format
84 TECH_DOCS += technical/long-running-process-protocol
85 TECH_DOCS += technical/multi-pack-index
86 TECH_DOCS += technical/pack-format
87 TECH_DOCS += technical/pack-heuristics
88 TECH_DOCS += technical/pack-protocol
89 TECH_DOCS += technical/partial-clone
90 TECH_DOCS += technical/protocol-capabilities
91 TECH_DOCS += technical/protocol-common
92 TECH_DOCS += technical/protocol-v2
93 TECH_DOCS += technical/racy-git
94 TECH_DOCS += technical/send-pack-pipeline
95 TECH_DOCS += technical/shallow
96 TECH_DOCS += technical/signature-format
97 TECH_DOCS += technical/trivial-merge
98 SP_ARTICLES += $(TECH_DOCS)
99 SP_ARTICLES += technical/api-index
101 ARTICLES_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
102 HTML_FILTER ?= $(ARTICLES_HTML) $(OBSOLETE_HTML)
103 DOC_HTML = $(MAN_HTML) $(filter $(HTML_FILTER),$(ARTICLES_HTML) $(OBSOLETE_HTML))
105 DOC_MAN1 = $(patsubst %.txt,%.1,$(filter $(MAN_FILTER),$(MAN1_TXT)))
106 DOC_MAN5 = $(patsubst %.txt,%.5,$(filter $(MAN_FILTER),$(MAN5_TXT)))
107 DOC_MAN7 = $(patsubst %.txt,%.7,$(filter $(MAN_FILTER),$(MAN7_TXT)))
109 prefix ?= $(HOME)
110 bindir ?= $(prefix)/bin
111 htmldir ?= $(prefix)/share/doc/git-doc
112 infodir ?= $(prefix)/share/info
113 pdfdir ?= $(prefix)/share/doc/git-doc
114 mandir ?= $(prefix)/share/man
115 man1dir = $(mandir)/man1
116 man5dir = $(mandir)/man5
117 man7dir = $(mandir)/man7
118 # DESTDIR =
120 ASCIIDOC = asciidoc
121 ASCIIDOC_EXTRA =
122 ASCIIDOC_HTML = xhtml11
123 ASCIIDOC_DOCBOOK = docbook
124 ASCIIDOC_CONF = -f asciidoc.conf
125 ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF) \
126 -agit_version=$(GIT_VERSION)
127 TXT_TO_HTML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_HTML)
128 TXT_TO_XML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_DOCBOOK)
129 MANPAGE_XSL = manpage-normal.xsl
130 XMLTO = xmlto
131 XMLTO_EXTRA =
132 INSTALL ?= install
133 RM ?= rm -f
134 MAN_REPO = ../../git-manpages
135 HTML_REPO = ../../git-htmldocs
137 MAKEINFO = makeinfo
138 INSTALL_INFO = install-info
139 DOCBOOK2X_TEXI = docbook2x-texi
140 DBLATEX = dblatex
141 ASCIIDOC_DBLATEX_DIR = /etc/asciidoc/dblatex
142 DBLATEX_COMMON = -p $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.xsl -s $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.sty
143 ifndef PERL_PATH
144 PERL_PATH = /usr/bin/perl
145 endif
147 -include ../config.mak.autogen
148 -include ../config.mak
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
160 ifdef DOCBOOK_XSL_172
161 ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
162 MANPAGE_XSL = manpage-1.72.xsl
163 else
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
169 endif
170 ifndef NO_MAN_BOLD_LITERAL
171 XMLTO_EXTRA += -m manpage-bold-literal.xsl
172 endif
173 ifdef DOCBOOK_SUPPRESS_SP
174 XMLTO_EXTRA += -m manpage-suppress-sp.xsl
175 endif
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.
181 # Distros may want to use MAN_BASE_URL=file:///path/to/git/docs/
182 # or similar.
183 ifndef MAN_BASE_URL
184 MAN_BASE_URL = file://$(htmldir)/
185 endif
186 XMLTO_EXTRA += -m manpage-base-url.xsl
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.
192 ifdef GNU_ROFF
193 XMLTO_EXTRA += -m manpage-quote-apos.xsl
194 endif
196 ifdef USE_ASCIIDOCTOR
197 ASCIIDOC = asciidoctor
198 ASCIIDOC_CONF =
199 ASCIIDOC_HTML = xhtml5
200 ASCIIDOC_DOCBOOK = docbook45
201 ASCIIDOC_EXTRA += -acompat-mode -atabsize=8
202 ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions
203 ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;'
204 DBLATEX_COMMON =
205 endif
207 SHELL_PATH ?= $(SHELL)
208 # Shell quote;
209 SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
211 ifdef DEFAULT_PAGER
212 DEFAULT_PAGER_SQ = $(subst ','\'',$(DEFAULT_PAGER))
213 ASCIIDOC_EXTRA += -a 'git-default-pager=$(DEFAULT_PAGER_SQ)'
214 endif
216 ifdef DEFAULT_EDITOR
217 DEFAULT_EDITOR_SQ = $(subst ','\'',$(DEFAULT_EDITOR))
218 ASCIIDOC_EXTRA += -a 'git-default-editor=$(DEFAULT_EDITOR_SQ)'
219 endif
221 QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir
222 QUIET_SUBDIR1 =
224 ifneq ($(findstring $(MAKEFLAGS),w),w)
225 PRINT_DIR = --no-print-directory
226 else # "make -w"
227 NO_SUBDIR = :
228 endif
230 ifneq ($(findstring $(MAKEFLAGS),s),s)
231 ifndef 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
245 endif
246 endif
248 all: html man
250 html: $(DOC_HTML)
252 man: man1 man5 man7
253 man1: $(DOC_MAN1)
254 man5: $(DOC_MAN5)
255 man7: $(DOC_MAN7)
257 info: git.info gitman.info
259 pdf: user-manual.pdf
261 install: install-man
263 install-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)
271 install-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 ; \
281 install-pdf: pdf
282 $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
283 $(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)
285 install-html: html
286 '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
288 ../GIT-VERSION-FILE: FORCE
289 $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
291 -include ../GIT-VERSION-FILE
294 # Determine "include::" file references in asciidoc files.
296 docdep_prereqs = \
297 mergetools-list.made $(mergetools_txt) \
298 cmd-list.made $(cmds_txt)
300 doc.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 $@+ $@
305 -include doc.dep
307 cmds_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
317 $(cmds_txt): cmd-list.made
319 cmd-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 >$@
324 mergetools_txt = mergetools-diff.txt mergetools-merge.txt
326 $(mergetools_txt): mergetools-list.made
328 mergetools-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 >$@
338 TRACK_ASCIIDOCFLAGS = $(subst ','\'',$(ASCIIDOC_COMMON):$(ASCIIDOC_HTML):$(ASCIIDOC_DOCBOOK))
340 GIT-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; \
347 clean:
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
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 $@+ $@
363 $(OBSOLETE_HTML): %.html : %.txto asciidoc.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
364 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
365 $(TXT_TO_HTML) -o $@+ $< && \
366 mv $@+ $@
368 manpage-base-url.xsl: manpage-base-url.xsl.in
369 $(QUIET_GEN)sed "s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|" $< > $@
371 %.1 %.5 %.7 : %.xml manpage-base-url.xsl $(wildcard manpage*.xsl)
372 $(QUIET_XMLTO)$(RM) $@ && \
373 $(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
375 %.xml : %.txt asciidoc.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
376 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
377 $(TXT_TO_XML) -d manpage -o $@+ $< && \
378 mv $@+ $@
380 user-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 $@+ $@
385 technical/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
389 technical/%.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
394 SubmittingPatches.txt: SubmittingPatches
395 $(QUIET_GEN) cp $< $@
397 XSLT = docbook.xsl
398 XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
400 user-manual.html: user-manual.xml $(XSLT)
401 $(QUIET_XSLTPROC)$(RM) $@+ $@ && \
402 xsltproc $(XSLTOPTS) -o $@+ $(XSLT) $< && \
403 mv $@+ $@
405 git.info: user-manual.texi
406 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
408 user-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 $@+ $@
415 user-manual.pdf: user-manual.xml
416 $(QUIET_DBLATEX)$(RM) $@+ $@ && \
417 $(DBLATEX) -o $@+ $(DBLATEX_COMMON) $< && \
418 mv $@+ $@
420 gitman.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 $@+ $@
429 gitman.info: gitman.texi
430 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
432 $(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
433 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
434 $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
435 mv $@+ $@
437 howto-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 $@+ $@
442 $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
443 $(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt
445 WEBDOC_DEST = /pub/software/scm/git/docs
447 howto/%.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 $@+ $@
454 install-webdoc : html
455 '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
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.
460 quick-install: quick-install-man
462 require-manrepo::
463 @if test ! -d $(MAN_REPO); \
464 then echo "git-manpages repository must exist at $(MAN_REPO)"; exit 1; fi
466 quick-install-man: require-manrepo
467 '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(MAN_REPO) $(DESTDIR)$(mandir) $(GIT_MAN_REF)
469 require-htmlrepo::
470 @if test ! -d $(HTML_REPO); \
471 then echo "git-htmldocs repository must exist at $(HTML_REPO)"; exit 1; fi
473 quick-install-html: require-htmlrepo
474 '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REPO) $(DESTDIR)$(htmldir) $(GIT_MAN_REF)
476 print-man1:
477 @for i in $(MAN1_TXT); do echo $$i; done
479 lint-docs::
480 $(QUIET_LINT)$(PERL_PATH) lint-gitlink.perl
482 ifeq ($(wildcard po/Makefile),po/Makefile)
483 doc-l10n install-l10n::
484 $(MAKE) -C po $@
485 endif
487 .PHONY: FORCE