cvsserver: updated documentation
[git/git.git] / Documentation / Makefile
CommitLineData
88db5f80 1MAN1_TXT=$(wildcard git-*.txt) gitk.txt
b2bf34d6 2MAN7_TXT=git.txt
b790abb8 3
2a29da7c 4DOC_HTML=$(patsubst %.txt,%.html,$(MAN1_TXT) $(MAN7_TXT))
8db9307c 5
a1d4aa74 6ARTICLES = tutorial
dcc6e28f 7ARTICLES += core-tutorial
a1d4aa74
JH
8ARTICLES += cvs-migration
9ARTICLES += diffcore
10ARTICLES += howto-index
11ARTICLES += repository-layout
6d35cc76 12ARTICLES += hooks
db9536c8 13ARTICLES += everyday
8db9307c
JH
14# with their own formatting rules.
15SP_ARTICLES = glossary howto/revert-branch-rebase
16
17DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
789d5774 18
b2bf34d6
DG
19DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
20DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
21
d2b8593f 22prefix?=$(HOME)
87a81c83
EB
23bin=$(prefix)/bin
24mandir=$(prefix)/man
25man1=$(mandir)/man1
26man7=$(mandir)/man7
a682ef9f 27# DESTDIR=
87a81c83 28
d2b8593f 29INSTALL?=install
87a81c83 30
b2bf34d6
DG
31#
32# Please note that there is a minor bug in asciidoc.
33# The version after 6.0.3 _will_ include the patch found here:
34# http://marc.theaimsgroup.com/?l=git&m=111558757202243&w=2
35#
36# Until that version is released you may have to apply the patch
37# yourself - yes, all 6 characters of it!
38#
39
40all: html man
b790abb8
DG
41
42html: $(DOC_HTML)
43
b2bf34d6
DG
44
45man: man1 man7
46man1: $(DOC_MAN1)
47man7: $(DOC_MAN7)
b790abb8 48
b163512d 49install: man
53764ee4 50 $(INSTALL) -d -m755 $(DESTDIR)/$(man1) $(DESTDIR)/$(man7)
a682ef9f
PB
51 $(INSTALL) $(DOC_MAN1) $(DESTDIR)/$(man1)
52 $(INSTALL) $(DOC_MAN7) $(DESTDIR)/$(man7)
87a81c83 53
37465016 54
93d69d86
JL
55#
56# Determine "include::" file references in asciidoc files.
57#
fb612d54 58doc.dep : $(wildcard *.txt) build-docdep.perl
a5ae8e64
JH
59 rm -f $@+ $@
60 perl ./build-docdep.perl >$@+
61 mv $@+ $@
93d69d86 62
a5ae8e64 63-include doc.dep
37465016 64
941c9449
PR
65git.7: README
66
67README: ../README
68 cp $< $@
b790abb8 69
93d69d86 70
b790abb8 71clean:
941c9449 72 rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html doc.dep README
b790abb8
DG
73
74%.html : %.txt
d1c2e113 75 asciidoc -b xhtml11 -d manpage -f asciidoc.conf $<
b790abb8 76
7984eabe 77%.1 %.7 : %.xml
b790abb8
DG
78 xmlto man $<
79
80%.xml : %.txt
d1c2e113 81 asciidoc -b docbook -d manpage -f asciidoc.conf $<
3f971fc4 82
941c9449 83git.html: git.txt README
8db9307c 84
23bb8df2
JS
85glossary.html : glossary.txt sort_glossary.pl
86 cat $< | \
87 perl sort_glossary.pl | \
88 asciidoc -b xhtml11 - > glossary.html
89
e6fc2346
JH
90howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
91 rm -f $@+ $@
92 sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
93 mv $@+ $@
94
8db9307c
JH
95$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
96 asciidoc -b xhtml11 $*.txt
e6fc2346
JH
97
98WEBDOC_DEST = /pub/software/scm/git/docs
99
8d0991d7
JH
100$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
101 rm -f $@+ $@
102 sed -e '1,/^$$/d' $? | asciidoc -b xhtml11 - >$@+
103 mv $@+ $@
104
e6fc2346
JH
105install-webdoc : html
106 sh ./install-webdoc.sh $(WEBDOC_DEST)