Mark user-manual as UTF-8
[git/git.git] / Documentation / Makefile
1 MAN1_TXT= \
2 $(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
3 $(wildcard git-*.txt)) \
4 gitk.txt
5 MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt
6 MAN7_TXT=git.txt
7
8 DOC_HTML=$(patsubst %.txt,%.html,$(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT))
9
10 ARTICLES = tutorial
11 ARTICLES += tutorial-2
12 ARTICLES += core-tutorial
13 ARTICLES += cvs-migration
14 ARTICLES += diffcore
15 ARTICLES += howto-index
16 ARTICLES += repository-layout
17 ARTICLES += hooks
18 ARTICLES += everyday
19 ARTICLES += git-tools
20 ARTICLES += glossary
21 # with their own formatting rules.
22 SP_ARTICLES = howto/revert-branch-rebase user-manual
23
24 DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
25
26 DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
27 DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT))
28 DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
29
30 prefix?=$(HOME)
31 bindir?=$(prefix)/bin
32 mandir?=$(prefix)/share/man
33 man1dir=$(mandir)/man1
34 man5dir=$(mandir)/man5
35 man7dir=$(mandir)/man7
36 # DESTDIR=
37
38 ASCIIDOC=asciidoc
39 ASCIIDOC_EXTRA =
40 ifdef ASCIIDOC8
41 ASCIIDOC_EXTRA += -a asciidoc7compatible
42 endif
43 INSTALL?=install
44 RM ?= rm -f
45 DOC_REF = origin/man
46
47 -include ../config.mak.autogen
48 -include ../config.mak
49
50 #
51 # Please note that there is a minor bug in asciidoc.
52 # The version after 6.0.3 _will_ include the patch found here:
53 # http://marc.theaimsgroup.com/?l=git&m=111558757202243&w=2
54 #
55 # Until that version is released you may have to apply the patch
56 # yourself - yes, all 6 characters of it!
57 #
58
59 all: html man
60
61 html: $(DOC_HTML)
62
63 $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
64
65 man: man1 man5 man7
66 man1: $(DOC_MAN1)
67 man5: $(DOC_MAN5)
68 man7: $(DOC_MAN7)
69
70 install: man
71 $(INSTALL) -d -m755 $(DESTDIR)$(man1dir)
72 $(INSTALL) -d -m755 $(DESTDIR)$(man5dir)
73 $(INSTALL) -d -m755 $(DESTDIR)$(man7dir)
74 $(INSTALL) -m644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
75 $(INSTALL) -m644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
76 $(INSTALL) -m644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
77
78
79 ../GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
80 $(MAKE) -C ../ GIT-VERSION-FILE
81
82 -include ../GIT-VERSION-FILE
83
84 #
85 # Determine "include::" file references in asciidoc files.
86 #
87 doc.dep : $(wildcard *.txt) build-docdep.perl
88 $(RM) $@+ $@
89 perl ./build-docdep.perl >$@+
90 mv $@+ $@
91
92 -include doc.dep
93
94 cmds_txt = cmds-ancillaryinterrogators.txt \
95 cmds-ancillarymanipulators.txt \
96 cmds-mainporcelain.txt \
97 cmds-plumbinginterrogators.txt \
98 cmds-plumbingmanipulators.txt \
99 cmds-synchingrepositories.txt \
100 cmds-synchelpers.txt \
101 cmds-purehelpers.txt \
102 cmds-foreignscminterface.txt
103
104 $(cmds_txt): cmd-list.made
105
106 cmd-list.made: cmd-list.perl $(MAN1_TXT)
107 perl ./cmd-list.perl
108 date >$@
109
110 git.7 git.html: git.txt core-intro.txt
111
112 clean:
113 $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7 howto-index.txt howto/*.html doc.dep
114 $(RM) $(cmds_txt) *.made
115
116 %.html : %.txt
117 $(RM) $@+ $@
118 $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
119 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $<
120 mv $@+ $@
121
122 %.1 %.5 %.7 : %.xml
123 xmlto -m callouts.xsl man $<
124
125 %.xml : %.txt
126 $(RM) $@+ $@
127 $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
128 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $<
129 mv $@+ $@
130
131 user-manual.xml: user-manual.txt user-manual.conf
132 $(ASCIIDOC) -b docbook -d book $<
133
134 XSLT = docbook.xsl
135 XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
136
137 user-manual.html: user-manual.xml
138 xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
139
140 howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
141 $(RM) $@+ $@
142 sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
143 mv $@+ $@
144
145 $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
146 $(ASCIIDOC) -b xhtml11 $*.txt
147
148 WEBDOC_DEST = /pub/software/scm/git/docs
149
150 $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
151 $(RM) $@+ $@
152 sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b xhtml11 - >$@+
153 mv $@+ $@
154
155 install-webdoc : html
156 sh ./install-webdoc.sh $(WEBDOC_DEST)
157
158 quick-install:
159 sh ./install-doc-quick.sh $(DOC_REF) $(mandir)
160
161 .PHONY: .FORCE-GIT-VERSION-FILE