]> git.ipfire.org Git - thirdparty/git.git/blame_incremental - Documentation/Makefile
Documentation: sync git.txt command list and manual page title
[thirdparty/git.git] / Documentation / Makefile
... / ...
CommitLineData
1MAN1_TXT= \
2 $(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
3 $(wildcard git-*.txt)) \
4 gitk.txt
5MAN7_TXT=git.txt
6
7DOC_HTML=$(patsubst %.txt,%.html,$(MAN1_TXT) $(MAN7_TXT))
8
9ARTICLES = tutorial
10ARTICLES += tutorial-2
11ARTICLES += core-tutorial
12ARTICLES += cvs-migration
13ARTICLES += diffcore
14ARTICLES += howto-index
15ARTICLES += repository-layout
16ARTICLES += hooks
17ARTICLES += everyday
18ARTICLES += git-tools
19# with their own formatting rules.
20SP_ARTICLES = glossary howto/revert-branch-rebase
21
22DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
23
24DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
25DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
26
27prefix?=$(HOME)
28bindir?=$(prefix)/bin
29mandir?=$(prefix)/man
30man1dir=$(mandir)/man1
31man7dir=$(mandir)/man7
32# DESTDIR=
33
34INSTALL?=install
35DOC_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
48all: html man
49
50html: $(DOC_HTML)
51
52$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN7): asciidoc.conf
53
54man: man1 man7
55man1: $(DOC_MAN1)
56man7: $(DOC_MAN7)
57
58install: 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#
67doc.dep : $(wildcard *.txt) build-docdep.perl
68 rm -f $@+ $@
69 perl ./build-docdep.perl >$@+
70 mv $@+ $@
71
72-include doc.dep
73
74git.7 git.html: git.txt core-intro.txt
75
76
77clean:
78 rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html doc.dep
79
80%.html : %.txt
81 asciidoc -b xhtml11 -d manpage -f asciidoc.conf $<
82
83%.1 %.7 : %.xml
84 xmlto -m callouts.xsl man $<
85
86%.xml : %.txt
87 asciidoc -b docbook -d manpage -f asciidoc.conf $<
88
89glossary.html : glossary.txt sort_glossary.pl
90 cat $< | \
91 perl sort_glossary.pl | \
92 asciidoc -b xhtml11 - > glossary.html
93
94howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
95 rm -f $@+ $@
96 sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
97 mv $@+ $@
98
99$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
100 asciidoc -b xhtml11 $*.txt
101
102WEBDOC_DEST = /pub/software/scm/git/docs
103
104$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
105 rm -f $@+ $@
106 sed -e '1,/^$$/d' $< | asciidoc -b xhtml11 - >$@+
107 mv $@+ $@
108
109install-webdoc : html
110 sh ./install-webdoc.sh $(WEBDOC_DEST)
111
112quick-install:
113 sh ./install-doc-quick.sh $(DOC_REF) $(mandir)