Merge branch 'master' of git://linux-nfs.org/~bfields/git
[git/git.git] / Documentation / Makefile
1 MAN1_TXT= \
2 $(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
3 $(wildcard git-*.txt)) \
4 gitk.txt
5 MAN7_TXT=git.txt
6
7 DOC_HTML=$(patsubst %.txt,%.html,$(MAN1_TXT) $(MAN7_TXT))
8
9 ARTICLES = tutorial
10 ARTICLES += tutorial-2
11 ARTICLES += core-tutorial
12 ARTICLES += cvs-migration
13 ARTICLES += diffcore
14 ARTICLES += howto-index
15 ARTICLES += repository-layout
16 ARTICLES += hooks
17 ARTICLES += everyday
18 ARTICLES += git-tools
19 # with their own formatting rules.
20 SP_ARTICLES = glossary howto/revert-branch-rebase user-manual
21
22 DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
23
24 DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
25 DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
26
27 prefix?=$(HOME)
28 bindir?=$(prefix)/bin
29 mandir?=$(prefix)/man
30 man1dir=$(mandir)/man1
31 man7dir=$(mandir)/man7
32 # DESTDIR=
33
34 INSTALL?=install
35 DOC_REF = origin/man
36
37 -include ../config.mak.autogen
38
39 #
40 # Please note that there is a minor bug in asciidoc.
41 # The version after 6.0.3 _will_ include the patch found here:
42 # http://marc.theaimsgroup.com/?l=git&m=111558757202243&w=2
43 #
44 # Until that version is released you may have to apply the patch
45 # yourself - yes, all 6 characters of it!
46 #
47
48 all: html man
49
50 html: $(DOC_HTML)
51
52 $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN7): asciidoc.conf
53
54 man: man1 man7
55 man1: $(DOC_MAN1)
56 man7: $(DOC_MAN7)
57
58 install: man
59 $(INSTALL) -d -m755 $(DESTDIR)$(man1dir) $(DESTDIR)$(man7dir)
60 $(INSTALL) -m644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
61 $(INSTALL) -m644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
62
63
64 #
65 # Determine "include::" file references in asciidoc files.
66 #
67 doc.dep : $(wildcard *.txt) build-docdep.perl
68 rm -f $@+ $@
69 perl ./build-docdep.perl >$@+
70 mv $@+ $@
71
72 -include doc.dep
73
74 cmds_txt = cmds-ancillaryinterrogators.txt \
75 cmds-ancillarymanipulators.txt \
76 cmds-mainporcelain.txt \
77 cmds-plumbinginterrogators.txt \
78 cmds-plumbingmanipulators.txt \
79 cmds-synchingrepositories.txt \
80 cmds-synchelpers.txt \
81 cmds-purehelpers.txt \
82 cmds-foreignscminterface.txt
83
84 $(cmds_txt): cmd-list.perl $(MAN1_TXT)
85 perl ./cmd-list.perl
86
87 git.7 git.html: git.txt core-intro.txt
88
89 clean:
90 rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html doc.dep
91 rm -f $(cmds_txt)
92
93 %.html : %.txt
94 asciidoc -b xhtml11 -d manpage -f asciidoc.conf $<
95
96 %.1 %.7 : %.xml
97 xmlto -m callouts.xsl man $<
98
99 %.xml : %.txt
100 asciidoc -b docbook -d manpage -f asciidoc.conf $<
101
102 user-manual.xml: user-manual.txt user-manual.conf
103 asciidoc -b docbook -d book $<
104
105 user-manual.html: user-manual.xml
106 xmlto -m /etc/asciidoc/docbook-xsl/xhtml.xsl html-nochunks $<
107
108 glossary.html : glossary.txt sort_glossary.pl
109 cat $< | \
110 perl sort_glossary.pl | \
111 asciidoc -b xhtml11 - > glossary.html
112
113 howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
114 rm -f $@+ $@
115 sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
116 mv $@+ $@
117
118 $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
119 asciidoc -b xhtml11 $*.txt
120
121 WEBDOC_DEST = /pub/software/scm/git/docs
122
123 $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
124 rm -f $@+ $@
125 sed -e '1,/^$$/d' $< | asciidoc -b xhtml11 - >$@+
126 mv $@+ $@
127
128 install-webdoc : html
129 sh ./install-webdoc.sh $(WEBDOC_DEST)
130
131 quick-install:
132 sh ./install-doc-quick.sh $(DOC_REF) $(mandir)