]>
Commit | Line | Data |
---|---|---|
8df786d2 ÆAB |
1 | # Import tree-wide shared Makefile behavior and libraries |
2 | include ../shared.mak | |
3 | ||
a617578d JK |
4 | # Guard against environment variables |
5 | MAN1_TXT = | |
6 | MAN5_TXT = | |
7 | MAN7_TXT = | |
824c621b | 8 | HOWTO_TXT = |
19bcc73e | 9 | DOC_DEP_TXT = |
43cc5ce9 JH |
10 | TECH_DOCS = |
11 | ARTICLES = | |
12 | SP_ARTICLES = | |
5a568ea0 | 13 | OBSOLETE_HTML = |
a617578d | 14 | |
faa7a096 JS |
15 | -include GIT-EXCLUDED-PROGRAMS |
16 | ||
a617578d | 17 | MAN1_TXT += $(filter-out \ |
faa7a096 | 18 | $(patsubst %,%.txt,$(EXCLUDED_PROGRAMS)) \ |
a617578d JK |
19 | $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \ |
20 | $(wildcard git-*.txt)) | |
21 | MAN1_TXT += git.txt | |
22 | MAN1_TXT += gitk.txt | |
23 | MAN1_TXT += gitweb.txt | |
24 | ||
2135e1ad | 25 | # man5 / man7 guides (note: new guides should also be added to command-list.txt) |
a617578d JK |
26 | MAN5_TXT += gitattributes.txt |
27 | MAN5_TXT += githooks.txt | |
28 | MAN5_TXT += gitignore.txt | |
42957af0 | 29 | MAN5_TXT += gitmailmap.txt |
a617578d JK |
30 | MAN5_TXT += gitmodules.txt |
31 | MAN5_TXT += gitrepository-layout.txt | |
32 | MAN5_TXT += gitweb.conf.txt | |
33 | ||
34 | MAN7_TXT += gitcli.txt | |
35 | MAN7_TXT += gitcore-tutorial.txt | |
a6fc9fd3 | 36 | MAN7_TXT += gitcredentials.txt |
a617578d JK |
37 | MAN7_TXT += gitcvs-migration.txt |
38 | MAN7_TXT += gitdiffcore.txt | |
673151a9 | 39 | MAN7_TXT += giteveryday.txt |
2149b674 | 40 | MAN7_TXT += gitfaq.txt |
a617578d JK |
41 | MAN7_TXT += gitglossary.txt |
42 | MAN7_TXT += gitnamespaces.txt | |
439cc746 | 43 | MAN7_TXT += gitremote-helpers.txt |
a617578d | 44 | MAN7_TXT += gitrevisions.txt |
d4803455 | 45 | MAN7_TXT += gitsubmodules.txt |
a617578d JK |
46 | MAN7_TXT += gittutorial-2.txt |
47 | MAN7_TXT += gittutorial.txt | |
48 | MAN7_TXT += gitworkflows.txt | |
b790abb8 | 49 | |
824c621b ÆAB |
50 | HOWTO_TXT += $(wildcard howto/*.txt) |
51 | ||
19bcc73e ÆAB |
52 | DOC_DEP_TXT += $(wildcard *.txt) |
53 | DOC_DEP_TXT += $(wildcard config/*.txt) | |
54 | ||
3d5b568f JNA |
55 | ifdef MAN_FILTER |
56 | MAN_TXT = $(filter $(MAN_FILTER),$(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)) | |
57 | else | |
5cefc33b | 58 | MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT) |
3d5b568f JNA |
59 | MAN_FILTER = $(MAN_TXT) |
60 | endif | |
61 | ||
692cfd6b JK |
62 | MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT)) |
63 | MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT)) | |
65289e9d | 64 | GIT_MAN_REF = master |
5cefc33b | 65 | |
673151a9 | 66 | OBSOLETE_HTML += everyday.html |
5a568ea0 | 67 | OBSOLETE_HTML += git-remote-helpers.html |
8db9307c | 68 | |
43cc5ce9 | 69 | ARTICLES += howto-index |
4a5d6939 | 70 | ARTICLES += git-tools |
69a9cd31 | 71 | ARTICLES += git-bisect-lk2009 |
8db9307c | 72 | # with their own formatting rules. |
43cc5ce9 | 73 | SP_ARTICLES += user-manual |
81670e9b | 74 | SP_ARTICLES += howto/new-command |
11b17afc JH |
75 | SP_ARTICLES += howto/revert-branch-rebase |
76 | SP_ARTICLES += howto/using-merge-subtree | |
77 | SP_ARTICLES += howto/using-signed-tag-in-pull-request | |
5e00439f TA |
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 | |
41dfbb2d | 84 | SP_ARTICLES += howto/recover-corrupted-object-harder |
5e00439f | 85 | SP_ARTICLES += howto/rebuild-from-update-hook |
5e00439f | 86 | SP_ARTICLES += howto/rebase-from-internal-branch |
0678b649 | 87 | SP_ARTICLES += howto/keep-canonical-history-correct |
5e00439f | 88 | SP_ARTICLES += howto/maintain-git |
09420b76 | 89 | SP_ARTICLES += howto/coordinate-embargoed-releases |
530e741c JH |
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) | |
5e00439f | 92 | |
76644e32 | 93 | TECH_DOCS += MyFirstContribution |
e0479fa0 | 94 | TECH_DOCS += MyFirstObjectWalk |
049e64aa | 95 | TECH_DOCS += SubmittingPatches |
6e4fd8bf | 96 | TECH_DOCS += technical/bundle-format |
752414ae | 97 | TECH_DOCS += technical/hash-function-transition |
43cc5ce9 | 98 | TECH_DOCS += technical/http-protocol |
586aa786 | 99 | TECH_DOCS += technical/index-format |
addad105 | 100 | TECH_DOCS += technical/long-running-process-protocol |
60568178 | 101 | TECH_DOCS += technical/multi-pack-index |
5e00439f TA |
102 | TECH_DOCS += technical/pack-format |
103 | TECH_DOCS += technical/pack-heuristics | |
104 | TECH_DOCS += technical/pack-protocol | |
68e66f29 | 105 | TECH_DOCS += technical/parallel-checkout |
5641eb94 | 106 | TECH_DOCS += technical/partial-clone |
5e00439f TA |
107 | TECH_DOCS += technical/protocol-capabilities |
108 | TECH_DOCS += technical/protocol-common | |
ed10cb95 | 109 | TECH_DOCS += technical/protocol-v2 |
5e00439f | 110 | TECH_DOCS += technical/racy-git |
35e6c474 | 111 | TECH_DOCS += technical/reftable |
5e00439f TA |
112 | TECH_DOCS += technical/send-pack-pipeline |
113 | TECH_DOCS += technical/shallow | |
76f9d8ba | 114 | TECH_DOCS += technical/signature-format |
5e00439f TA |
115 | TECH_DOCS += technical/trivial-merge |
116 | SP_ARTICLES += $(TECH_DOCS) | |
530e741c | 117 | SP_ARTICLES += technical/api-index |
8db9307c | 118 | |
3d5b568f JNA |
119 | ARTICLES_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES)) |
120 | HTML_FILTER ?= $(ARTICLES_HTML) $(OBSOLETE_HTML) | |
121 | DOC_HTML = $(MAN_HTML) $(filter $(HTML_FILTER),$(ARTICLES_HTML) $(OBSOLETE_HTML)) | |
789d5774 | 122 | |
3d5b568f JNA |
123 | DOC_MAN1 = $(patsubst %.txt,%.1,$(filter $(MAN_FILTER),$(MAN1_TXT))) |
124 | DOC_MAN5 = $(patsubst %.txt,%.5,$(filter $(MAN_FILTER),$(MAN5_TXT))) | |
125 | DOC_MAN7 = $(patsubst %.txt,%.7,$(filter $(MAN_FILTER),$(MAN7_TXT))) | |
b2bf34d6 | 126 | |
692cfd6b JK |
127 | prefix ?= $(HOME) |
128 | bindir ?= $(prefix)/bin | |
129 | htmldir ?= $(prefix)/share/doc/git-doc | |
e21db2c6 | 130 | infodir ?= $(prefix)/share/info |
692cfd6b JK |
131 | pdfdir ?= $(prefix)/share/doc/git-doc |
132 | mandir ?= $(prefix)/share/man | |
133 | man1dir = $(mandir)/man1 | |
134 | man5dir = $(mandir)/man5 | |
135 | man7dir = $(mandir)/man7 | |
136 | # DESTDIR = | |
87a81c83 | 137 | |
dd4f3075 | 138 | ASCIIDOC = asciidoc |
26cfcfbf | 139 | ASCIIDOC_EXTRA = |
7d61547d | 140 | ASCIIDOC_HTML = xhtml11 |
141 | ASCIIDOC_DOCBOOK = docbook | |
142 | ASCIIDOC_CONF = -f asciidoc.conf | |
da8a3664 | 143 | ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF) \ |
226daba2 MÅ |
144 | -amanversion=$(GIT_VERSION) \ |
145 | -amanmanual='Git Manual' -amansource='Git' | |
56da2139 | 146 | ASCIIDOC_DEPS = asciidoc.conf GIT-ASCIIDOCFLAGS |
da8a3664 | 147 | TXT_TO_HTML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_HTML) |
148 | TXT_TO_XML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_DOCBOOK) | |
c30e9485 | 149 | MANPAGE_XSL = manpage-normal.xsl |
dd4f3075 | 150 | XMLTO = xmlto |
5121a6d9 | 151 | XMLTO_EXTRA = |
692cfd6b | 152 | INSTALL ?= install |
4cb08df5 | 153 | RM ?= rm -f |
fcbebfdd JH |
154 | MAN_REPO = ../../git-manpages |
155 | HTML_REPO = ../../git-htmldocs | |
87a81c83 | 156 | |
692cfd6b JK |
157 | MAKEINFO = makeinfo |
158 | INSTALL_INFO = install-info | |
159 | DOCBOOK2X_TEXI = docbook2x-texi | |
160 | DBLATEX = dblatex | |
0079d6eb | 161 | ASCIIDOC_DBLATEX_DIR = /etc/asciidoc/dblatex |
ae4e3e8d | 162 | DBLATEX_COMMON = -p $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.xsl -s $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.sty |
c680dd83 JH |
163 | ifndef PERL_PATH |
164 | PERL_PATH = /usr/bin/perl | |
165 | endif | |
4739809c | 166 | |
95676853 | 167 | -include ../config.mak.autogen |
4fa96e15 | 168 | -include ../config.mak |
95676853 | 169 | |
59457170 | 170 | ifndef NO_MAN_BOLD_LITERAL |
5121a6d9 CJ |
171 | XMLTO_EXTRA += -m manpage-bold-literal.xsl |
172 | endif | |
7f55cf45 | 173 | |
8dd35c71 | 174 | # Newer DocBook stylesheet emits warning cruft in the output when |
50d9bbba TZ |
175 | # this is not set, and if set it shows an absolute link. Older |
176 | # stylesheets simply ignore this parameter. | |
59a0a0bd | 177 | # |
50d9bbba TZ |
178 | # Distros may want to use MAN_BASE_URL=file:///path/to/git/docs/ |
179 | # or similar. | |
180 | ifndef MAN_BASE_URL | |
181 | MAN_BASE_URL = file://$(htmldir)/ | |
59a0a0bd | 182 | endif |
50d9bbba | 183 | XMLTO_EXTRA += -m manpage-base-url.xsl |
a479a564 | 184 | |
204d363f TR |
185 | # If your target system uses GNU groff, it may try to render |
186 | # apostrophes as a "pretty" apostrophe using unicode. This breaks | |
187 | # cut&paste, so you should set GNU_ROFF to force them to be ASCII | |
188 | # apostrophes. Unfortunately does not work with non-GNU roff. | |
189 | ifdef GNU_ROFF | |
190 | XMLTO_EXTRA += -m manpage-quote-apos.xsl | |
191 | endif | |
192 | ||
ec3366eb | 193 | ifdef USE_ASCIIDOCTOR |
194 | ASCIIDOC = asciidoctor | |
195 | ASCIIDOC_CONF = | |
196 | ASCIIDOC_HTML = xhtml5 | |
f6461b82 | 197 | ASCIIDOC_DOCBOOK = docbook5 |
743e63f3 | 198 | ASCIIDOC_EXTRA += -acompat-mode -atabsize=8 |
55d2d812 | 199 | ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions |
ec3366eb | 200 | ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;' |
56da2139 | 201 | ASCIIDOC_DEPS = asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS |
ec3366eb | 202 | DBLATEX_COMMON = |
f6461b82 | 203 | XMLTO_EXTRA += --skip-validation |
204 | XMLTO_EXTRA += -x manpage.xsl | |
ec3366eb | 205 | endif |
206 | ||
ee7ec2f9 BW |
207 | SHELL_PATH ?= $(SHELL) |
208 | # Shell quote; | |
209 | SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH)) | |
210 | ||
5b58619a JN |
211 | ifdef DEFAULT_PAGER |
212 | DEFAULT_PAGER_SQ = $(subst ','\'',$(DEFAULT_PAGER)) | |
213 | ASCIIDOC_EXTRA += -a 'git-default-pager=$(DEFAULT_PAGER_SQ)' | |
214 | endif | |
215 | ||
216 | ifdef DEFAULT_EDITOR | |
217 | DEFAULT_EDITOR_SQ = $(subst ','\'',$(DEFAULT_EDITOR)) | |
218 | ASCIIDOC_EXTRA += -a 'git-default-editor=$(DEFAULT_EDITOR_SQ)' | |
219 | endif | |
220 | ||
b2bf34d6 | 221 | all: html man |
b790abb8 DG |
222 | |
223 | html: $(DOC_HTML) | |
224 | ||
4392da4d | 225 | man: man1 man5 man7 |
b2bf34d6 | 226 | man1: $(DOC_MAN1) |
4392da4d | 227 | man5: $(DOC_MAN5) |
b2bf34d6 | 228 | man7: $(DOC_MAN7) |
b790abb8 | 229 | |
5cefc33b | 230 | info: git.info gitman.info |
4739809c | 231 | |
a325a1a7 MV |
232 | pdf: user-manual.pdf |
233 | ||
b1a46b70 MH |
234 | install: install-man |
235 | ||
236 | install-man: man | |
41650765 RS |
237 | $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir) |
238 | $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir) | |
239 | $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir) | |
240 | $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir) | |
241 | $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir) | |
242 | $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir) | |
87a81c83 | 243 | |
4739809c | 244 | install-info: info |
41650765 | 245 | $(INSTALL) -d -m 755 $(DESTDIR)$(infodir) |
5cefc33b | 246 | $(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir) |
4739809c DK |
247 | if test -r $(DESTDIR)$(infodir)/dir; then \ |
248 | $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\ | |
5cefc33b | 249 | $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\ |
4739809c DK |
250 | else \ |
251 | echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \ | |
252 | fi | |
37465016 | 253 | |
a325a1a7 MV |
254 | install-pdf: pdf |
255 | $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir) | |
256 | $(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir) | |
257 | ||
5d6491c7 | 258 | install-html: html |
ee7ec2f9 | 259 | '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir) |
5d6491c7 | 260 | |
13fca9f3 | 261 | ../GIT-VERSION-FILE: FORCE |
bb230097 | 262 | $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE |
7b8a74f3 | 263 | |
8cc804d0 | 264 | ifneq ($(filter-out lint-docs clean,$(MAKECMDGOALS)),) |
7b8a74f3 | 265 | -include ../GIT-VERSION-FILE |
7a9272a8 | 266 | endif |
7b8a74f3 | 267 | |
93d69d86 JL |
268 | # |
269 | # Determine "include::" file references in asciidoc files. | |
270 | # | |
f35ec546 DA |
271 | docdep_prereqs = \ |
272 | mergetools-list.made $(mergetools_txt) \ | |
273 | cmd-list.made $(cmds_txt) | |
274 | ||
19bcc73e | 275 | doc.dep : $(docdep_prereqs) $(DOC_DEP_TXT) build-docdep.perl |
db10fc6c | 276 | $(QUIET_GEN)$(PERL_PATH) ./build-docdep.perl >$@ $(QUIET_STDERR) |
93d69d86 | 277 | |
54df8755 | 278 | ifneq ($(MAKECMDGOALS),clean) |
a5ae8e64 | 279 | -include doc.dep |
54df8755 | 280 | endif |
37465016 | 281 | |
72fe6a59 JH |
282 | cmds_txt = cmds-ancillaryinterrogators.txt \ |
283 | cmds-ancillarymanipulators.txt \ | |
284 | cmds-mainporcelain.txt \ | |
285 | cmds-plumbinginterrogators.txt \ | |
286 | cmds-plumbingmanipulators.txt \ | |
89bf2077 JH |
287 | cmds-synchingrepositories.txt \ |
288 | cmds-synchelpers.txt \ | |
f442f28a | 289 | cmds-guide.txt \ |
89bf2077 JH |
290 | cmds-purehelpers.txt \ |
291 | cmds-foreignscminterface.txt | |
72fe6a59 | 292 | |
d7907392 JH |
293 | $(cmds_txt): cmd-list.made |
294 | ||
79d30668 | 295 | cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT) |
471e7b2c | 296 | $(QUIET_GEN)$(PERL_PATH) ./cmd-list.perl ../command-list.txt $(cmds_txt) $(QUIET_STDERR) && \ |
d7907392 | 297 | date >$@ |
b790abb8 | 298 | |
f35ec546 DA |
299 | mergetools_txt = mergetools-diff.txt mergetools-merge.txt |
300 | ||
301 | $(mergetools_txt): mergetools-list.made | |
302 | ||
303 | mergetools-list.made: ../git-mergetool--lib.sh $(wildcard ../mergetools/*) | |
471e7b2c | 304 | $(QUIET_GEN) \ |
f35ec546 DA |
305 | $(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \ |
306 | . ../git-mergetool--lib.sh && \ | |
307 | show_tool_names can_diff "* " || :' >mergetools-diff.txt && \ | |
308 | $(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \ | |
309 | . ../git-mergetool--lib.sh && \ | |
310 | show_tool_names can_merge "* " || :' >mergetools-merge.txt && \ | |
311 | date >$@ | |
312 | ||
9a71722b MÅ |
313 | TRACK_ASCIIDOCFLAGS = $(subst ','\'',$(ASCIIDOC_COMMON):$(ASCIIDOC_HTML):$(ASCIIDOC_DOCBOOK)) |
314 | ||
315 | GIT-ASCIIDOCFLAGS: FORCE | |
316 | @FLAGS='$(TRACK_ASCIIDOCFLAGS)'; \ | |
317 | if test x"$$FLAGS" != x"`cat GIT-ASCIIDOCFLAGS 2>/dev/null`" ; then \ | |
318 | echo >&2 " * new asciidoc flags"; \ | |
319 | echo "$$FLAGS" >GIT-ASCIIDOCFLAGS; \ | |
320 | fi | |
321 | ||
b790abb8 | 322 | clean: |
8650c629 | 323 | $(RM) -rf .build/ |
4c785e50 | 324 | $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7 |
c6a5ad21 | 325 | $(RM) *.texi *.texi+ *.texi++ git.info gitman.info |
ae8044a2 | 326 | $(RM) *.pdf |
530e741c | 327 | $(RM) howto-index.txt howto/*.html doc.dep |
5e00439f | 328 | $(RM) technical/*.html technical/api-index.txt |
049e64aa | 329 | $(RM) SubmittingPatches.txt |
f35ec546 | 330 | $(RM) $(cmds_txt) $(mergetools_txt) *.made |
50d9bbba | 331 | $(RM) manpage-base-url.xsl |
9a71722b | 332 | $(RM) GIT-ASCIIDOCFLAGS |
b790abb8 | 333 | |
12d078ed | 334 | $(MAN_HTML): %.html : %.txt $(ASCIIDOC_DEPS) |
db10fc6c | 335 | $(QUIET_ASCIIDOC)$(TXT_TO_HTML) -d manpage -o $@ $< |
b790abb8 | 336 | |
12d078ed | 337 | $(OBSOLETE_HTML): %.html : %.txto $(ASCIIDOC_DEPS) |
db10fc6c | 338 | $(QUIET_ASCIIDOC)$(TXT_TO_HTML) -o $@ $< |
bd4a3d61 | 339 | |
50d9bbba | 340 | manpage-base-url.xsl: manpage-base-url.xsl.in |
96a7501a | 341 | $(QUIET_GEN)sed "s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|" $< > $@ |
50d9bbba | 342 | |
c91d03aa | 343 | %.1 %.5 %.7 : %.xml manpage-base-url.xsl $(wildcard manpage*.xsl) |
471e7b2c | 344 | $(QUIET_XMLTO)$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $< |
b790abb8 | 345 | |
12d078ed | 346 | %.xml : %.txt $(ASCIIDOC_DEPS) |
db10fc6c | 347 | $(QUIET_ASCIIDOC)$(TXT_TO_XML) -d manpage -o $@ $< |
3f971fc4 | 348 | |
08c9757a | 349 | user-manual.xml: user-manual.txt user-manual.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS |
db10fc6c | 350 | $(QUIET_ASCIIDOC)$(TXT_TO_XML) -d book -o $@ $< |
d19fbc3c | 351 | |
530e741c JH |
352 | technical/api-index.txt: technical/api-index-skel.txt \ |
353 | technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS)) | |
ee7ec2f9 | 354 | $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh |
530e741c | 355 | |
fe77b416 | 356 | technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../ |
9a71722b MÅ |
357 | $(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt \ |
358 | asciidoc.conf GIT-ASCIIDOCFLAGS | |
da8a3664 | 359 | $(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt |
530e741c | 360 | |
049e64aa | 361 | SubmittingPatches.txt: SubmittingPatches |
362 | $(QUIET_GEN) cp $< $@ | |
363 | ||
1cffddd6 | 364 | XSLT = docbook.xsl |
3569e11d AE |
365 | XSLTOPTS = |
366 | XSLTOPTS += --xinclude | |
367 | XSLTOPTS += --stringparam html.stylesheet docbook-xsl.css | |
368 | XSLTOPTS += --param generate.consistent.ids 1 | |
1c95c565 | 369 | |
f2aff316 | 370 | user-manual.html: user-manual.xml $(XSLT) |
db10fc6c | 371 | $(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $< |
d19fbc3c | 372 | |
50b3555c | 373 | git.info: user-manual.texi |
bb230097 | 374 | $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi |
5cefc33b | 375 | |
50b3555c | 376 | user-manual.texi: user-manual.xml |
db10fc6c FC |
377 | $(QUIET_DB2TEXI)$(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@+ && \ |
378 | $(PERL_PATH) fix-texi.perl <$@+ >$@ && \ | |
7ba30167 | 379 | $(RM) $@+ |
5cefc33b | 380 | |
a325a1a7 | 381 | user-manual.pdf: user-manual.xml |
db10fc6c | 382 | $(QUIET_DBLATEX)$(DBLATEX) -o $@ $(DBLATEX_COMMON) $< |
a325a1a7 | 383 | |
95e5efc6 | 384 | gitman.texi: $(MAN_XML) cat-texi.perl texi.xsl |
471e7b2c | 385 | $(QUIET_DB2TEXI) \ |
95e5efc6 | 386 | ($(foreach xml,$(sort $(MAN_XML)),xsltproc -o $(xml)+ texi.xsl $(xml) && \ |
387 | $(DOCBOOK2X_TEXI) --encoding=UTF-8 --to-stdout $(xml)+ && \ | |
7ba30167 | 388 | $(RM) $(xml)+ &&) true) > $@+ && \ |
db10fc6c | 389 | $(PERL_PATH) cat-texi.perl $@ <$@+ >$@ && \ |
7ba30167 | 390 | $(RM) $@+ |
5cefc33b JH |
391 | |
392 | gitman.info: gitman.texi | |
8af0699b | 393 | $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $< |
5cefc33b JH |
394 | |
395 | $(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml | |
db10fc6c | 396 | $(QUIET_DB2TEXI)$(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@ |
4739809c | 397 | |
824c621b | 398 | howto-index.txt: howto-index.sh $(HOWTO_TXT) |
db10fc6c | 399 | $(QUIET_GEN)'$(SHELL_PATH_SQ)' ./howto-index.sh $(sort $(HOWTO_TXT)) >$@ |
e6fc2346 | 400 | |
8db9307c | 401 | $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt |
da8a3664 | 402 | $(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt |
e6fc2346 JH |
403 | |
404 | WEBDOC_DEST = /pub/software/scm/git/docs | |
405 | ||
fe77b416 | 406 | howto/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../ |
824c621b | 407 | $(patsubst %.txt,%.html,$(HOWTO_TXT)): %.html : %.txt GIT-ASCIIDOCFLAGS |
471e7b2c | 408 | $(QUIET_ASCIIDOC) \ |
7d61547d | 409 | sed -e '1,/^$$/d' $< | \ |
db10fc6c | 410 | $(TXT_TO_HTML) - >$@ |
8d0991d7 | 411 | |
e6fc2346 | 412 | install-webdoc : html |
ee7ec2f9 | 413 | '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST) |
6538d1ef | 414 | |
2de9b711 TA |
415 | # You must have a clone of 'git-htmldocs' and 'git-manpages' repositories |
416 | # next to the 'git' repository itself for the following to work. | |
fcbebfdd | 417 | |
b1a46b70 MH |
418 | quick-install: quick-install-man |
419 | ||
fcbebfdd JH |
420 | require-manrepo:: |
421 | @if test ! -d $(MAN_REPO); \ | |
422 | then echo "git-manpages repository must exist at $(MAN_REPO)"; exit 1; fi | |
423 | ||
424 | quick-install-man: require-manrepo | |
65289e9d | 425 | '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(MAN_REPO) $(DESTDIR)$(mandir) $(GIT_MAN_REF) |
fcbebfdd JH |
426 | |
427 | require-htmlrepo:: | |
428 | @if test ! -d $(HTML_REPO); \ | |
429 | then echo "git-htmldocs repository must exist at $(HTML_REPO)"; exit 1; fi | |
7b8a74f3 | 430 | |
fcbebfdd | 431 | quick-install-html: require-htmlrepo |
65289e9d | 432 | '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REPO) $(DESTDIR)$(htmldir) $(GIT_MAN_REF) |
6fe570de | 433 | |
5fafce0b JK |
434 | print-man1: |
435 | @for i in $(MAN1_TXT); do echo $$i; done | |
436 | ||
8650c629 | 437 | ## Lint: gitlink |
8650c629 | 438 | LINT_DOCS_GITLINK = $(patsubst %.txt,.build/lint-docs/gitlink/%.ok,$(HOWTO_TXT) $(DOC_DEP_TXT)) |
8650c629 ÆAB |
439 | $(LINT_DOCS_GITLINK): lint-gitlink.perl |
440 | $(LINT_DOCS_GITLINK): .build/lint-docs/gitlink/%.ok: %.txt | |
0b6d0bc9 | 441 | $(call mkdir_p_parent_template) |
8650c629 ÆAB |
442 | $(QUIET_LINT_GITLINK)$(PERL_PATH) lint-gitlink.perl \ |
443 | $< \ | |
d2c99080 ÆAB |
444 | $(HOWTO_TXT) $(DOC_DEP_TXT) \ |
445 | --section=1 $(MAN1_TXT) \ | |
446 | --section=5 $(MAN5_TXT) \ | |
8650c629 ÆAB |
447 | --section=7 $(MAN7_TXT) >$@ |
448 | .PHONY: lint-docs-gitlink | |
449 | lint-docs-gitlink: $(LINT_DOCS_GITLINK) | |
450 | ||
451 | ## Lint: man-end-blurb | |
8650c629 | 452 | LINT_DOCS_MAN_END_BLURB = $(patsubst %.txt,.build/lint-docs/man-end-blurb/%.ok,$(MAN_TXT)) |
8650c629 ÆAB |
453 | $(LINT_DOCS_MAN_END_BLURB): lint-man-end-blurb.perl |
454 | $(LINT_DOCS_MAN_END_BLURB): .build/lint-docs/man-end-blurb/%.ok: %.txt | |
0b6d0bc9 | 455 | $(call mkdir_p_parent_template) |
8650c629 ÆAB |
456 | $(QUIET_LINT_MANEND)$(PERL_PATH) lint-man-end-blurb.perl $< >$@ |
457 | .PHONY: lint-docs-man-end-blurb | |
8650c629 ÆAB |
458 | |
459 | ## Lint: man-section-order | |
8650c629 | 460 | LINT_DOCS_MAN_SECTION_ORDER = $(patsubst %.txt,.build/lint-docs/man-section-order/%.ok,$(MAN_TXT)) |
8650c629 ÆAB |
461 | $(LINT_DOCS_MAN_SECTION_ORDER): lint-man-section-order.perl |
462 | $(LINT_DOCS_MAN_SECTION_ORDER): .build/lint-docs/man-section-order/%.ok: %.txt | |
0b6d0bc9 | 463 | $(call mkdir_p_parent_template) |
8650c629 ÆAB |
464 | $(QUIET_LINT_MANSEC)$(PERL_PATH) lint-man-section-order.perl $< >$@ |
465 | .PHONY: lint-docs-man-section-order | |
466 | lint-docs-man-section-order: $(LINT_DOCS_MAN_SECTION_ORDER) | |
467 | ||
468 | ## Lint: list of targets above | |
469 | .PHONY: lint-docs | |
470 | lint-docs: lint-docs-gitlink | |
471 | lint-docs: lint-docs-man-end-blurb | |
472 | lint-docs: lint-docs-man-section-order | |
ab81411c | 473 | |
3d5b568f JNA |
474 | ifeq ($(wildcard po/Makefile),po/Makefile) |
475 | doc-l10n install-l10n:: | |
476 | $(MAKE) -C po $@ | |
477 | endif | |
478 | ||
13fca9f3 | 479 | .PHONY: FORCE |