[git/git.git] / Documentation / Makefile

MAN1_TXT= \
	$(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
		$(wildcard git-*.txt)) \
	gitk.txt
MAN7_TXT=git.txt

DOC_HTML=$(patsubst %.txt,%.html,$(MAN1_TXT) $(MAN7_TXT))

ARTICLES = tutorial
ARTICLES += tutorial-2
ARTICLES += core-tutorial
ARTICLES += cvs-migration
ARTICLES += diffcore
ARTICLES += howto-index
ARTICLES += repository-layout
ARTICLES += hooks
ARTICLES += everyday
ARTICLES += git-tools
# 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.
#
doc.dep : $(wildcard *.txt) build-docdep.perl
	rm -f $@+ $@
	perl ./build-docdep.perl >$@+
	mv $@+ $@

-include doc.dep

git.7: README

README: ../README
	cp $< $@


clean:
	rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html doc.dep README

%.html : %.txt
	asciidoc -b xhtml11 -d manpage -f asciidoc.conf $<

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