1 # Import tree-wide shared Makefile behavior and libraries
4 # Guard against environment variables
15 -include GIT-EXCLUDED-PROGRAMS
17 MAN1_TXT
+= $(filter-out \
18 $(patsubst %,%.txt
,$(EXCLUDED_PROGRAMS
)) \
19 $(addsuffix .txt
, $(ARTICLES
) $(SP_ARTICLES
)), \
20 $(wildcard git-
*.txt
))
23 MAN1_TXT
+= gitweb.txt
25 # man5 / man7 guides (note: new guides should also be added to command-list.txt)
26 MAN5_TXT
+= gitattributes.txt
27 MAN5_TXT
+= githooks.txt
28 MAN5_TXT
+= gitignore.txt
29 MAN5_TXT
+= gitmailmap.txt
30 MAN5_TXT
+= gitmodules.txt
31 MAN5_TXT
+= gitrepository-layout.txt
32 MAN5_TXT
+= gitweb.conf.txt
34 MAN7_TXT
+= gitcli.txt
35 MAN7_TXT
+= gitcore-tutorial.txt
36 MAN7_TXT
+= gitcredentials.txt
37 MAN7_TXT
+= gitcvs-migration.txt
38 MAN7_TXT
+= gitdiffcore.txt
39 MAN7_TXT
+= giteveryday.txt
40 MAN7_TXT
+= gitfaq.txt
41 MAN7_TXT
+= gitglossary.txt
42 MAN7_TXT
+= gitnamespaces.txt
43 MAN7_TXT
+= gitremote-helpers.txt
44 MAN7_TXT
+= gitrevisions.txt
45 MAN7_TXT
+= gitsubmodules.txt
46 MAN7_TXT
+= gittutorial-2.txt
47 MAN7_TXT
+= gittutorial.txt
48 MAN7_TXT
+= gitworkflows.txt
50 HOWTO_TXT
+= $(wildcard howto
/*.txt
)
52 DOC_DEP_TXT
+= $(wildcard *.txt
)
53 DOC_DEP_TXT
+= $(wildcard config
/*.txt
)
56 MAN_TXT
= $(filter $(MAN_FILTER
),$(MAN1_TXT
) $(MAN5_TXT
) $(MAN7_TXT
))
58 MAN_TXT
= $(MAN1_TXT
) $(MAN5_TXT
) $(MAN7_TXT
)
59 MAN_FILTER
= $(MAN_TXT
)
62 MAN_XML
= $(patsubst %.txt
,%.xml
,$(MAN_TXT
))
63 MAN_HTML
= $(patsubst %.txt
,%.html
,$(MAN_TXT
))
66 OBSOLETE_HTML
+= everyday.html
67 OBSOLETE_HTML
+= git-remote-helpers.html
69 ARTICLES
+= howto-index
71 ARTICLES
+= git-bisect-lk2009
72 # with their own formatting rules.
73 SP_ARTICLES
+= user-manual
74 SP_ARTICLES
+= howto
/new-command
75 SP_ARTICLES
+= howto
/revert-branch-rebase
76 SP_ARTICLES
+= howto
/using-merge-subtree
77 SP_ARTICLES
+= howto
/using-signed-tag-in-pull-request
78 SP_ARTICLES
+= howto
/use-git-daemon
79 SP_ARTICLES
+= howto
/update-hook-example
80 SP_ARTICLES
+= howto
/setup-git-server-over-http
81 SP_ARTICLES
+= howto
/separating-topic-branches
82 SP_ARTICLES
+= howto
/revert-a-faulty-merge
83 SP_ARTICLES
+= howto
/recover-corrupted-blob-object
84 SP_ARTICLES
+= howto
/recover-corrupted-object-harder
85 SP_ARTICLES
+= howto
/rebuild-from-update-hook
86 SP_ARTICLES
+= howto
/rebase-from-internal-branch
87 SP_ARTICLES
+= howto
/keep-canonical-history-correct
88 SP_ARTICLES
+= howto
/maintain-git
89 SP_ARTICLES
+= howto
/coordinate-embargoed-releases
90 API_DOCS
= $(patsubst %.txt
,%,$(filter-out technical
/api-index-skel.txt technical
/api-index.txt
, $(wildcard technical
/api-
*.txt
)))
91 SP_ARTICLES
+= $(API_DOCS
)
93 TECH_DOCS
+= MyFirstContribution
94 TECH_DOCS
+= MyFirstObjectWalk
95 TECH_DOCS
+= SubmittingPatches
96 TECH_DOCS
+= ToolsForGit
97 TECH_DOCS
+= technical
/bitmap-format
98 TECH_DOCS
+= technical
/bundle-format
99 TECH_DOCS
+= technical
/cruft-packs
100 TECH_DOCS
+= technical
/hash-function-transition
101 TECH_DOCS
+= technical
/http-protocol
102 TECH_DOCS
+= technical
/index-format
103 TECH_DOCS
+= technical
/long-running-process-protocol
104 TECH_DOCS
+= technical
/multi-pack-index
105 TECH_DOCS
+= technical
/pack-format
106 TECH_DOCS
+= technical
/pack-heuristics
107 TECH_DOCS
+= technical
/pack-protocol
108 TECH_DOCS
+= technical
/parallel-checkout
109 TECH_DOCS
+= technical
/partial-clone
110 TECH_DOCS
+= technical
/protocol-capabilities
111 TECH_DOCS
+= technical
/protocol-common
112 TECH_DOCS
+= technical
/protocol-v2
113 TECH_DOCS
+= technical
/racy-git
114 TECH_DOCS
+= technical
/reftable
115 TECH_DOCS
+= technical
/send-pack-pipeline
116 TECH_DOCS
+= technical
/shallow
117 TECH_DOCS
+= technical
/signature-format
118 TECH_DOCS
+= technical
/trivial-merge
119 SP_ARTICLES
+= $(TECH_DOCS
)
120 SP_ARTICLES
+= technical
/api-index
122 ARTICLES_HTML
+= $(patsubst %,%.html
,$(ARTICLES
) $(SP_ARTICLES
))
123 HTML_FILTER ?
= $(ARTICLES_HTML
) $(OBSOLETE_HTML
)
124 DOC_HTML
= $(MAN_HTML
) $(filter $(HTML_FILTER
),$(ARTICLES_HTML
) $(OBSOLETE_HTML
))
126 DOC_MAN1
= $(patsubst %.txt
,%.1,$(filter $(MAN_FILTER
),$(MAN1_TXT
)))
127 DOC_MAN5
= $(patsubst %.txt
,%.5,$(filter $(MAN_FILTER
),$(MAN5_TXT
)))
128 DOC_MAN7
= $(patsubst %.txt
,%.7,$(filter $(MAN_FILTER
),$(MAN7_TXT
)))
131 bindir ?
= $(prefix)/bin
132 htmldir ?
= $(prefix)/share
/doc
/git-doc
133 infodir ?
= $(prefix)/share
/info
134 pdfdir ?
= $(prefix)/share
/doc
/git-doc
135 mandir ?
= $(prefix)/share
/man
136 man1dir = $(mandir)/man1
137 man5dir = $(mandir)/man5
138 man7dir = $(mandir)/man7
143 ASCIIDOC_HTML
= xhtml11
144 ASCIIDOC_DOCBOOK
= docbook
145 ASCIIDOC_CONF
= -f asciidoc.conf
146 ASCIIDOC_COMMON
= $(ASCIIDOC
) $(ASCIIDOC_EXTRA
) $(ASCIIDOC_CONF
) \
147 -amanversion
=$(GIT_VERSION
) \
148 -amanmanual
='Git Manual' -amansource
='Git'
149 ASCIIDOC_DEPS
= asciidoc.conf GIT-ASCIIDOCFLAGS
150 TXT_TO_HTML
= $(ASCIIDOC_COMMON
) -b
$(ASCIIDOC_HTML
)
151 TXT_TO_XML
= $(ASCIIDOC_COMMON
) -b
$(ASCIIDOC_DOCBOOK
)
152 MANPAGE_XSL
= manpage-normal.xsl
157 MAN_REPO
= ..
/..
/git-manpages
158 HTML_REPO
= ..
/..
/git-htmldocs
161 INSTALL_INFO
= install-info
162 DOCBOOK2X_TEXI
= docbook2x-texi
164 ASCIIDOC_DBLATEX_DIR
= /etc
/asciidoc
/dblatex
165 DBLATEX_COMMON
= -p
$(ASCIIDOC_DBLATEX_DIR
)/asciidoc-dblatex.xsl
-s
$(ASCIIDOC_DBLATEX_DIR
)/asciidoc-dblatex.sty
167 PERL_PATH
= /usr
/bin
/perl
170 -include ..
/config.mak.autogen
171 -include ..
/config.mak
173 ifndef NO_MAN_BOLD_LITERAL
174 XMLTO_EXTRA
+= -m manpage-bold-literal.xsl
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/
184 MAN_BASE_URL
= file
://$(htmldir
)/
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.
193 XMLTO_EXTRA
+= -m manpage-quote-apos.xsl
196 ifdef USE_ASCIIDOCTOR
197 ASCIIDOC
= asciidoctor
199 ASCIIDOC_HTML
= xhtml5
200 ASCIIDOC_DOCBOOK
= docbook5
201 ASCIIDOC_EXTRA
+= -acompat-mode
-atabsize
=8
202 ASCIIDOC_EXTRA
+= -I.
-rasciidoctor-extensions
203 ASCIIDOC_EXTRA
+= -alitdd
='&\#x2d;&\#x2d;'
204 ASCIIDOC_DEPS
= asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
206 XMLTO_EXTRA
+= --skip-validation
207 XMLTO_EXTRA
+= -x manpage.xsl
210 SHELL_PATH ?
= $(SHELL
)
212 SHELL_PATH_SQ
= $(subst ','\'',$(SHELL_PATH))
215 DEFAULT_PAGER_SQ = $(subst ','\'',$(DEFAULT_PAGER
))
216 ASCIIDOC_EXTRA
+= -a
'git-default-pager=$(DEFAULT_PAGER_SQ)'
220 DEFAULT_EDITOR_SQ
= $(subst ','\'',$(DEFAULT_EDITOR))
221 ASCIIDOC_EXTRA += -a 'git-default-editor
=$(DEFAULT_EDITOR_SQ
)'
233 info: git.info gitman.info
240 $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
241 $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
242 $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
243 $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
244 $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
245 $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
248 $(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
249 $(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
250 if test -r $(DESTDIR)$(infodir)/dir; then \
251 $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
252 $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
254 echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
258 $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
259 $(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)
262 '$(SHELL_PATH_SQ
)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
264 ../GIT-VERSION-FILE: FORCE
265 $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
267 ifneq ($(filter-out lint-docs clean,$(MAKECMDGOALS)),)
268 -include ../GIT-VERSION-FILE
272 # Determine "include::" file references in asciidoc files.
275 mergetools-list.made $(mergetools_txt) \
276 cmd-list.made $(cmds_txt)
278 doc.dep : $(docdep_prereqs) $(DOC_DEP_TXT) build-docdep.perl
279 $(QUIET_GEN)$(PERL_PATH) ./build-docdep.perl >$@ $(QUIET_STDERR)
281 ifneq ($(MAKECMDGOALS),clean)
285 cmds_txt = cmds-ancillaryinterrogators.txt \
286 cmds-ancillarymanipulators.txt \
287 cmds-mainporcelain.txt \
288 cmds-plumbinginterrogators.txt \
289 cmds-plumbingmanipulators.txt \
290 cmds-synchingrepositories.txt \
291 cmds-synchelpers.txt \
293 cmds-purehelpers.txt \
294 cmds-foreignscminterface.txt
296 $(cmds_txt): cmd-list.made
298 cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
299 $(QUIET_GEN)$(PERL_PATH) ./cmd-list.perl ../command-list.txt $(cmds_txt) $(QUIET_STDERR) && \
302 mergetools_txt = mergetools-diff.txt mergetools-merge.txt
304 $(mergetools_txt): mergetools-list.made
306 mergetools-list.made: ../git-mergetool--lib.sh $(wildcard ../mergetools/*)
308 $(SHELL_PATH) -c 'MERGE_TOOLS_DIR
=..
/mergetools
&& TOOL_MODE
=diff
&& \
309 . ..
/git-mergetool--lib.sh
&& \
310 show_tool_names can_diff
' | sed -e "s/\([a-z0-9]*\)/\`\1\`;;/" >mergetools-diff.txt && \
311 $(SHELL_PATH) -c 'MERGE_TOOLS_DIR
=..
/mergetools
&& TOOL_MODE
=merge
&& \
312 . ..
/git-mergetool--lib.sh
&& \
313 show_tool_names can_merge
' | sed -e "s/\([a-z0-9]*\)/\`\1\`;;/" >mergetools-merge.txt && \
316 TRACK_ASCIIDOCFLAGS = $(subst ','\'',$(ASCIIDOC_COMMON
):$(ASCIIDOC_HTML
):$(ASCIIDOC_DOCBOOK
))
318 GIT-ASCIIDOCFLAGS
: FORCE
319 @FLAGS
='$(TRACK_ASCIIDOCFLAGS)'; \
320 if
test x
"$$FLAGS" != x
"`cat GIT-ASCIIDOCFLAGS 2>/dev/null`" ; then \
321 echo
>&2 " * new asciidoc flags"; \
322 echo
"$$FLAGS" >GIT-ASCIIDOCFLAGS
; \
327 $(RM
) *.xml
*.xml
+ *.html
*.html
+ *.1 *.5 *.7
328 $(RM
) *.texi
*.texi
+ *.texi
++ git.
info gitman.
info
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 $(RM
) GIT-ASCIIDOCFLAGS
337 $(MAN_HTML
): %.html
: %.txt
$(ASCIIDOC_DEPS
)
338 $(QUIET_ASCIIDOC
)$(TXT_TO_HTML
) -d manpage
-o
$@
$<
340 $(OBSOLETE_HTML
): %.html
: %.txto
$(ASCIIDOC_DEPS
)
341 $(QUIET_ASCIIDOC
)$(TXT_TO_HTML
) -o
$@
$<
343 manpage-base-url.xsl
: manpage-base-url.xsl.in
344 $(QUIET_GEN
)sed
"s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|" $< > $@
346 %.1 %.5 %.7 : %.xml manpage-base-url.xsl
$(wildcard manpage
*.xsl
)
347 $(QUIET_XMLTO
)$(XMLTO
) -m
$(MANPAGE_XSL
) $(XMLTO_EXTRA
) man
$<
349 %.xml
: %.txt
$(ASCIIDOC_DEPS
)
350 $(QUIET_ASCIIDOC
)$(TXT_TO_XML
) -d manpage
-o
$@
$<
352 user-manual.xml
: user-manual.txt user-manual.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
353 $(QUIET_ASCIIDOC
)$(TXT_TO_XML
) -d book
-o
$@
$<
355 technical
/api-index.txt
: technical
/api-index-skel.txt \
356 technical
/api-index.sh
$(patsubst %,%.txt
,$(API_DOCS
))
357 $(QUIET_GEN
)cd technical
&& '$(SHELL_PATH_SQ)' .
/api-index.sh
359 technical
/%.html
: ASCIIDOC_EXTRA
+= -a git-relative-html-prefix
=..
/
360 $(patsubst %,%.html
,$(API_DOCS
) technical
/api-index
$(TECH_DOCS
)): %.html
: %.txt \
361 asciidoc.conf GIT-ASCIIDOCFLAGS
362 $(QUIET_ASCIIDOC
)$(TXT_TO_HTML
) $*.txt
364 SubmittingPatches.txt
: SubmittingPatches
365 $(QUIET_GEN
) cp
$< $@
369 XSLTOPTS
+= --xinclude
370 XSLTOPTS
+= --stringparam html.stylesheet docbook-xsl.css
371 XSLTOPTS
+= --param generate.consistent.ids
1
373 user-manual.html
: user-manual.xml
$(XSLT
)
374 $(QUIET_XSLTPROC
)xsltproc
$(XSLTOPTS
) -o
$@
$(XSLT
) $<
376 git.
info: user-manual.texi
377 $(QUIET_MAKEINFO
)$(MAKEINFO
) --no-split
-o
$@ user-manual.texi
379 user-manual.texi
: user-manual.xml
380 $(QUIET_DB2TEXI
)$(DOCBOOK2X_TEXI
) user-manual.xml
--encoding
=UTF-8
--to-stdout
>$@
+ && \
381 $(PERL_PATH
) fix-texi.perl
<$@
+ >$@
&& \
384 user-manual.pdf
: user-manual.xml
385 $(QUIET_DBLATEX
)$(DBLATEX
) -o
$@
$(DBLATEX_COMMON
) $<
387 gitman.texi
: $(MAN_XML
) cat-texi.perl texi.xsl
389 ($(foreach xml
,$(sort $(MAN_XML
)),xsltproc
-o
$(xml
)+ texi.xsl
$(xml
) && \
390 $(DOCBOOK2X_TEXI
) --encoding
=UTF-8
--to-stdout
$(xml
)+ && \
391 $(RM
) $(xml
)+ &&) true
) > $@
+ && \
392 $(PERL_PATH
) cat-texi.perl
$@
<$@
+ >$@
&& \
395 gitman.
info: gitman.texi
396 $(QUIET_MAKEINFO
)$(MAKEINFO
) --no-split
--no-validate
$<
398 $(patsubst %.txt
,%.texi
,$(MAN_TXT
)): %.texi
: %.xml
399 $(QUIET_DB2TEXI
)$(DOCBOOK2X_TEXI
) --to-stdout
$*.xml
>$@
401 howto-index.txt
: howto-index.sh
$(HOWTO_TXT
)
402 $(QUIET_GEN
)'$(SHELL_PATH_SQ)' .
/howto-index.sh
$(sort $(HOWTO_TXT
)) >$@
404 $(patsubst %,%.html
,$(ARTICLES
)) : %.html
: %.txt
405 $(QUIET_ASCIIDOC
)$(TXT_TO_HTML
) $*.txt
407 WEBDOC_DEST
= /pub
/software
/scm
/git
/docs
409 howto
/%.html
: ASCIIDOC_EXTRA
+= -a git-relative-html-prefix
=..
/
410 $(patsubst %.txt
,%.html
,$(HOWTO_TXT
)): %.html
: %.txt GIT-ASCIIDOCFLAGS
412 sed
-e
'1,/^$$/d' $< | \
415 install-webdoc
: html
416 '$(SHELL_PATH_SQ)' .
/install-webdoc.sh
$(WEBDOC_DEST
)
418 # You must have a clone of 'git-htmldocs' and 'git-manpages' repositories
419 # next to the 'git' repository itself for the following to work.
421 quick-install
: quick-install-man
424 @if
test ! -d
$(MAN_REPO
); \
425 then echo
"git-manpages repository must exist at $(MAN_REPO)"; exit
1; fi
427 quick-install-man
: require-manrepo
428 '$(SHELL_PATH_SQ)' .
/install-doc-quick.sh
$(MAN_REPO
) $(DESTDIR
)$(mandir) $(GIT_MAN_REF
)
431 @if
test ! -d
$(HTML_REPO
); \
432 then echo
"git-htmldocs repository must exist at $(HTML_REPO)"; exit
1; fi
434 quick-install-html
: require-htmlrepo
435 '$(SHELL_PATH_SQ)' .
/install-doc-quick.sh
$(HTML_REPO
) $(DESTDIR
)$(htmldir
) $(GIT_MAN_REF
)
438 @for i in
$(MAN1_TXT
); do echo
$$i; done
441 LINT_DOCS_GITLINK
= $(patsubst %.txt
,.build
/lint-docs
/gitlink
/%.ok
,$(HOWTO_TXT
) $(DOC_DEP_TXT
))
442 $(LINT_DOCS_GITLINK
): lint-gitlink.perl
443 $(LINT_DOCS_GITLINK
): .build
/lint-docs
/gitlink
/%.ok
: %.txt
444 $(call mkdir_p_parent_template
)
445 $(QUIET_LINT_GITLINK
)$(PERL_PATH
) lint-gitlink.perl \
447 $(HOWTO_TXT
) $(DOC_DEP_TXT
) \
448 --section
=1 $(MAN1_TXT
) \
449 --section
=5 $(MAN5_TXT
) \
450 --section
=7 $(MAN7_TXT
) >$@
451 .PHONY
: lint-docs-gitlink
452 lint-docs-gitlink
: $(LINT_DOCS_GITLINK
)
454 ## Lint: man-end-blurb
455 LINT_DOCS_MAN_END_BLURB
= $(patsubst %.txt
,.build
/lint-docs
/man-end-blurb
/%.ok
,$(MAN_TXT
))
456 $(LINT_DOCS_MAN_END_BLURB
): lint-man-end-blurb.perl
457 $(LINT_DOCS_MAN_END_BLURB
): .build
/lint-docs
/man-end-blurb
/%.ok
: %.txt
458 $(call mkdir_p_parent_template
)
459 $(QUIET_LINT_MANEND
)$(PERL_PATH
) lint-man-end-blurb.perl
$< >$@
460 .PHONY
: lint-docs-man-end-blurb
462 ## Lint: man-section-order
463 LINT_DOCS_MAN_SECTION_ORDER
= $(patsubst %.txt
,.build
/lint-docs
/man-section-order
/%.ok
,$(MAN_TXT
))
464 $(LINT_DOCS_MAN_SECTION_ORDER
): lint-man-section-order.perl
465 $(LINT_DOCS_MAN_SECTION_ORDER
): .build
/lint-docs
/man-section-order
/%.ok
: %.txt
466 $(call mkdir_p_parent_template
)
467 $(QUIET_LINT_MANSEC
)$(PERL_PATH
) lint-man-section-order.perl
$< >$@
468 .PHONY
: lint-docs-man-section-order
469 lint-docs-man-section-order
: $(LINT_DOCS_MAN_SECTION_ORDER
)
471 ## Lint: list of targets above
473 lint-docs
: lint-docs-gitlink
474 lint-docs
: lint-docs-man-end-blurb
475 lint-docs
: lint-docs-man-section-order
477 ifeq ($(wildcard po
/Makefile
),po
/Makefile
)
478 doc-l10n install-l10n
::