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