status: show commit sha1 in "You are currently cherry-picking" message
[git/mjg.git] / Documentation / Makefile
blob4f13a23893047a022be23d245d2df920b1845eac
1 # Guard against environment variables
2 MAN1_TXT =
3 MAN5_TXT =
4 MAN7_TXT =
6 MAN1_TXT += $(filter-out \
7 $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
8 $(wildcard git-*.txt))
9 MAN1_TXT += git.txt
10 MAN1_TXT += gitk.txt
11 MAN1_TXT += gitremote-helpers.txt
12 MAN1_TXT += gitweb.txt
14 MAN5_TXT += gitattributes.txt
15 MAN5_TXT += githooks.txt
16 MAN5_TXT += gitignore.txt
17 MAN5_TXT += gitmodules.txt
18 MAN5_TXT += gitrepository-layout.txt
19 MAN5_TXT += gitweb.conf.txt
21 MAN7_TXT += gitcli.txt
22 MAN7_TXT += gitcore-tutorial.txt
23 MAN7_TXT += gitcredentials.txt
24 MAN7_TXT += gitcvs-migration.txt
25 MAN7_TXT += gitdiffcore.txt
26 MAN7_TXT += gitglossary.txt
27 MAN7_TXT += gitnamespaces.txt
28 MAN7_TXT += gitrevisions.txt
29 MAN7_TXT += gittutorial-2.txt
30 MAN7_TXT += gittutorial.txt
31 MAN7_TXT += gitworkflows.txt
33 MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
34 MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
35 MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT))
37 OBSOLETE_HTML = git-remote-helpers.html
38 DOC_HTML = $(MAN_HTML) $(OBSOLETE_HTML)
40 ARTICLES = howto-index
41 ARTICLES += everyday
42 ARTICLES += git-tools
43 ARTICLES += git-bisect-lk2009
44 # with their own formatting rules.
45 SP_ARTICLES = user-manual
46 SP_ARTICLES += howto/new-command
47 SP_ARTICLES += howto/revert-branch-rebase
48 SP_ARTICLES += howto/using-merge-subtree
49 SP_ARTICLES += howto/using-signed-tag-in-pull-request
50 SP_ARTICLES += howto/use-git-daemon
51 SP_ARTICLES += howto/update-hook-example
52 SP_ARTICLES += howto/setup-git-server-over-http
53 SP_ARTICLES += howto/separating-topic-branches
54 SP_ARTICLES += howto/revert-a-faulty-merge
55 SP_ARTICLES += howto/recover-corrupted-blob-object
56 SP_ARTICLES += howto/rebuild-from-update-hook
57 SP_ARTICLES += howto/rebase-from-internal-branch
58 SP_ARTICLES += howto/maintain-git
59 API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
60 SP_ARTICLES += $(API_DOCS)
62 TECH_DOCS = technical/index-format
63 TECH_DOCS += technical/pack-format
64 TECH_DOCS += technical/pack-heuristics
65 TECH_DOCS += technical/pack-protocol
66 TECH_DOCS += technical/protocol-capabilities
67 TECH_DOCS += technical/protocol-common
68 TECH_DOCS += technical/racy-git
69 TECH_DOCS += technical/send-pack-pipeline
70 TECH_DOCS += technical/shallow
71 TECH_DOCS += technical/trivial-merge
72 SP_ARTICLES += $(TECH_DOCS)
73 SP_ARTICLES += technical/api-index
75 DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
77 DOC_MAN1 = $(patsubst %.txt,%.1,$(MAN1_TXT))
78 DOC_MAN5 = $(patsubst %.txt,%.5,$(MAN5_TXT))
79 DOC_MAN7 = $(patsubst %.txt,%.7,$(MAN7_TXT))
81 prefix ?= $(HOME)
82 bindir ?= $(prefix)/bin
83 htmldir ?= $(prefix)/share/doc/git-doc
84 infodir ?= $(prefix)/share/info
85 pdfdir ?= $(prefix)/share/doc/git-doc
86 mandir ?= $(prefix)/share/man
87 man1dir = $(mandir)/man1
88 man5dir = $(mandir)/man5
89 man7dir = $(mandir)/man7
90 # DESTDIR =
92 ASCIIDOC = asciidoc
93 ASCIIDOC_EXTRA =
94 MANPAGE_XSL = manpage-normal.xsl
95 XMLTO = xmlto
96 XMLTO_EXTRA =
97 INSTALL ?= install
98 RM ?= rm -f
99 MAN_REPO = ../../git-manpages
100 HTML_REPO = ../../git-htmldocs
102 MAKEINFO = makeinfo
103 INSTALL_INFO = install-info
104 DOCBOOK2X_TEXI = docbook2x-texi
105 DBLATEX = dblatex
106 ASCIIDOC_DBLATEX_DIR = /etc/asciidoc/dblatex
107 ifndef PERL_PATH
108 PERL_PATH = /usr/bin/perl
109 endif
111 -include ../config.mak.autogen
112 -include ../config.mak
115 # For docbook-xsl ...
116 # -1.68.1, no extra settings are needed?
117 # 1.69.0, set ASCIIDOC_ROFF?
118 # 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP?
119 # 1.71.1, set ASCIIDOC_ROFF?
120 # 1.72.0, set DOCBOOK_XSL_172.
121 # 1.73.0-, no extra settings are needed
124 ifdef DOCBOOK_XSL_172
125 ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
126 MANPAGE_XSL = manpage-1.72.xsl
127 else
128 ifndef ASCIIDOC_ROFF
129 # docbook-xsl after 1.72 needs the regular XSL, but will not
130 # pass-thru raw roff codes from asciidoc.conf, so turn them off.
131 ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
132 endif
133 endif
134 ifdef MAN_BOLD_LITERAL
135 XMLTO_EXTRA += -m manpage-bold-literal.xsl
136 endif
137 ifdef DOCBOOK_SUPPRESS_SP
138 XMLTO_EXTRA += -m manpage-suppress-sp.xsl
139 endif
141 # Newer DocBook stylesheet emits warning cruft in the output when
142 # this is not set, and if set it shows an absolute link. Older
143 # stylesheets simply ignore this parameter.
145 # Distros may want to use MAN_BASE_URL=file:///path/to/git/docs/
146 # or similar.
147 ifndef MAN_BASE_URL
148 MAN_BASE_URL = file://$(htmldir)/
149 endif
150 XMLTO_EXTRA += -m manpage-base-url.xsl
152 # If your target system uses GNU groff, it may try to render
153 # apostrophes as a "pretty" apostrophe using unicode. This breaks
154 # cut&paste, so you should set GNU_ROFF to force them to be ASCII
155 # apostrophes. Unfortunately does not work with non-GNU roff.
156 ifdef GNU_ROFF
157 XMLTO_EXTRA += -m manpage-quote-apos.xsl
158 endif
160 SHELL_PATH ?= $(SHELL)
161 # Shell quote;
162 SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
164 ifdef DEFAULT_PAGER
165 DEFAULT_PAGER_SQ = $(subst ','\'',$(DEFAULT_PAGER))
166 ASCIIDOC_EXTRA += -a 'git-default-pager=$(DEFAULT_PAGER_SQ)'
167 endif
169 ifdef DEFAULT_EDITOR
170 DEFAULT_EDITOR_SQ = $(subst ','\'',$(DEFAULT_EDITOR))
171 ASCIIDOC_EXTRA += -a 'git-default-editor=$(DEFAULT_EDITOR_SQ)'
172 endif
174 QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir
175 QUIET_SUBDIR1 =
177 ifneq ($(findstring $(MAKEFLAGS),w),w)
178 PRINT_DIR = --no-print-directory
179 else # "make -w"
180 NO_SUBDIR = :
181 endif
183 ifneq ($(findstring $(MAKEFLAGS),s),s)
184 ifndef V
185 QUIET_ASCIIDOC = @echo ' ' ASCIIDOC $@;
186 QUIET_XMLTO = @echo ' ' XMLTO $@;
187 QUIET_DB2TEXI = @echo ' ' DB2TEXI $@;
188 QUIET_MAKEINFO = @echo ' ' MAKEINFO $@;
189 QUIET_DBLATEX = @echo ' ' DBLATEX $@;
190 QUIET_XSLTPROC = @echo ' ' XSLTPROC $@;
191 QUIET_GEN = @echo ' ' GEN $@;
192 QUIET_STDERR = 2> /dev/null
193 QUIET_SUBDIR0 = +@subdir=
194 QUIET_SUBDIR1 = ;$(NO_SUBDIR) echo ' ' SUBDIR $$subdir; \
195 $(MAKE) $(PRINT_DIR) -C $$subdir
196 export V
197 endif
198 endif
200 all: html man
202 html: $(DOC_HTML)
204 man: man1 man5 man7
205 man1: $(DOC_MAN1)
206 man5: $(DOC_MAN5)
207 man7: $(DOC_MAN7)
209 info: git.info gitman.info
211 pdf: user-manual.pdf
213 install: install-man
215 install-man: man
216 $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
217 $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
218 $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
219 $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
220 $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
221 $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
223 install-info: info
224 $(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
225 $(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
226 if test -r $(DESTDIR)$(infodir)/dir; then \
227 $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
228 $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
229 else \
230 echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
233 install-pdf: pdf
234 $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
235 $(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)
237 install-html: html
238 '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
240 ../GIT-VERSION-FILE: FORCE
241 $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
243 -include ../GIT-VERSION-FILE
246 # Determine "include::" file references in asciidoc files.
248 docdep_prereqs = \
249 mergetools-list.made $(mergetools_txt) \
250 cmd-list.made $(cmds_txt)
252 doc.dep : $(docdep_prereqs) $(wildcard *.txt) build-docdep.perl
253 $(QUIET_GEN)$(RM) $@+ $@ && \
254 $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
255 mv $@+ $@
257 -include doc.dep
259 cmds_txt = cmds-ancillaryinterrogators.txt \
260 cmds-ancillarymanipulators.txt \
261 cmds-mainporcelain.txt \
262 cmds-plumbinginterrogators.txt \
263 cmds-plumbingmanipulators.txt \
264 cmds-synchingrepositories.txt \
265 cmds-synchelpers.txt \
266 cmds-purehelpers.txt \
267 cmds-foreignscminterface.txt
269 $(cmds_txt): cmd-list.made
271 cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
272 $(QUIET_GEN)$(RM) $@ && \
273 $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
274 date >$@
276 mergetools_txt = mergetools-diff.txt mergetools-merge.txt
278 $(mergetools_txt): mergetools-list.made
280 mergetools-list.made: ../git-mergetool--lib.sh $(wildcard ../mergetools/*)
281 $(QUIET_GEN)$(RM) $@ && \
282 $(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
283 . ../git-mergetool--lib.sh && \
284 show_tool_names can_diff "* " || :' >mergetools-diff.txt && \
285 $(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
286 . ../git-mergetool--lib.sh && \
287 show_tool_names can_merge "* " || :' >mergetools-merge.txt && \
288 date >$@
290 clean:
291 $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
292 $(RM) *.texi *.texi+ *.texi++ git.info gitman.info
293 $(RM) *.pdf
294 $(RM) howto-index.txt howto/*.html doc.dep
295 $(RM) technical/*.html technical/api-index.txt
296 $(RM) $(cmds_txt) $(mergetools_txt) *.made
297 $(RM) manpage-base-url.xsl
299 $(MAN_HTML): %.html : %.txt asciidoc.conf
300 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
301 $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
302 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
303 mv $@+ $@
305 $(OBSOLETE_HTML): %.html : %.txto asciidoc.conf
306 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
307 $(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
308 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
309 mv $@+ $@
311 manpage-base-url.xsl: manpage-base-url.xsl.in
312 sed "s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|" $< > $@
314 %.1 %.5 %.7 : %.xml manpage-base-url.xsl
315 $(QUIET_XMLTO)$(RM) $@ && \
316 $(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
318 %.xml : %.txt asciidoc.conf
319 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
320 $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
321 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
322 mv $@+ $@
324 user-manual.xml: user-manual.txt user-manual.conf
325 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
326 $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d book -o $@+ $< && \
327 mv $@+ $@
329 technical/api-index.txt: technical/api-index-skel.txt \
330 technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
331 $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh
333 technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
334 $(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt asciidoc.conf
335 $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
336 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
338 XSLT = docbook.xsl
339 XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
341 user-manual.html: user-manual.xml $(XSLT)
342 $(QUIET_XSLTPROC)$(RM) $@+ $@ && \
343 xsltproc $(XSLTOPTS) -o $@+ $(XSLT) $< && \
344 mv $@+ $@
346 git.info: user-manual.texi
347 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
349 user-manual.texi: user-manual.xml
350 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
351 $(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
352 $(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
353 rm $@++ && \
354 mv $@+ $@
356 user-manual.pdf: user-manual.xml
357 $(QUIET_DBLATEX)$(RM) $@+ $@ && \
358 $(DBLATEX) -o $@+ -p $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.xsl -s $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.sty $< && \
359 mv $@+ $@
361 gitman.texi: $(MAN_XML) cat-texi.perl
362 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
363 ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
364 --to-stdout $(xml) &&) true) > $@++ && \
365 $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
366 rm $@++ && \
367 mv $@+ $@
369 gitman.info: gitman.texi
370 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
372 $(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
373 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
374 $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
375 mv $@+ $@
377 howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
378 $(QUIET_GEN)$(RM) $@+ $@ && \
379 '$(SHELL_PATH_SQ)' ./howto-index.sh $(sort $(wildcard howto/*.txt)) >$@+ && \
380 mv $@+ $@
382 $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
383 $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 $*.txt
385 WEBDOC_DEST = /pub/software/scm/git/docs
387 howto/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
388 $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
389 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
390 sed -e '1,/^$$/d' $< | $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 - >$@+ && \
391 mv $@+ $@
393 install-webdoc : html
394 '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
396 # You must have a clone of 'git-htmldocs' and 'git-manpages' repositories
397 # next to the 'git' repository itself for the following to work.
399 quick-install: quick-install-man
401 require-manrepo::
402 @if test ! -d $(MAN_REPO); \
403 then echo "git-manpages repository must exist at $(MAN_REPO)"; exit 1; fi
405 quick-install-man: require-manrepo
406 '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(MAN_REPO) $(DESTDIR)$(mandir)
408 require-htmlrepo::
409 @if test ! -d $(HTML_REPO); \
410 then echo "git-htmldocs repository must exist at $(HTML_REPO)"; exit 1; fi
412 quick-install-html: require-htmlrepo
413 '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REPO) $(DESTDIR)$(htmldir)
415 print-man1:
416 @for i in $(MAN1_TXT); do echo $$i; done
418 .PHONY: FORCE