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