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