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