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