2006-03-05 10:36:33 +01:00
|
|
|
MAN1_TXT= \
|
|
|
|
$(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
|
|
|
|
$(wildcard git-*.txt)) \
|
|
|
|
gitk.txt
|
2007-12-13 11:20:01 +01:00
|
|
|
MAN5_TXT=gitattributes.txt gitignore.txt gitcli.txt gitmodules.txt
|
2005-05-22 19:44:15 +02:00
|
|
|
MAN7_TXT=git.txt
|
2005-05-10 23:32:39 +02:00
|
|
|
|
2007-12-10 10:15:57 +01:00
|
|
|
MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
|
|
|
|
MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
|
|
|
|
MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
|
|
|
|
|
|
|
|
DOC_HTML=$(MAN_HTML)
|
2005-08-30 22:51:01 +02:00
|
|
|
|
2005-09-02 01:56:13 +02:00
|
|
|
ARTICLES = tutorial
|
2006-05-22 01:49:34 +02:00
|
|
|
ARTICLES += tutorial-2
|
2006-01-23 07:43:59 +01:00
|
|
|
ARTICLES += core-tutorial
|
2005-09-02 01:56:13 +02:00
|
|
|
ARTICLES += cvs-migration
|
|
|
|
ARTICLES += diffcore
|
|
|
|
ARTICLES += howto-index
|
|
|
|
ARTICLES += repository-layout
|
2005-09-03 06:19:26 +02:00
|
|
|
ARTICLES += hooks
|
2005-12-10 08:07:29 +01:00
|
|
|
ARTICLES += everyday
|
2006-03-05 10:36:33 +01:00
|
|
|
ARTICLES += git-tools
|
2007-03-18 22:02:37 +01:00
|
|
|
ARTICLES += glossary
|
2005-08-30 22:51:01 +02:00
|
|
|
# with their own formatting rules.
|
2007-03-18 22:02:37 +01:00
|
|
|
SP_ARTICLES = howto/revert-branch-rebase user-manual
|
2007-11-25 08:48:04 +01:00
|
|
|
API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
|
|
|
|
SP_ARTICLES += $(API_DOCS)
|
|
|
|
SP_ARTICLES += technical/api-index
|
2005-08-30 22:51:01 +02:00
|
|
|
|
|
|
|
DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
|
2005-08-30 08:09:22 +02:00
|
|
|
|
2005-05-22 19:44:15 +02:00
|
|
|
DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
|
2007-04-22 09:11:41 +02:00
|
|
|
DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT))
|
2005-05-22 19:44:15 +02:00
|
|
|
DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
|
|
|
|
|
2005-10-09 00:54:37 +02:00
|
|
|
prefix?=$(HOME)
|
2006-06-29 22:11:25 +02:00
|
|
|
bindir?=$(prefix)/bin
|
2007-12-02 06:07:55 +01:00
|
|
|
htmldir?=$(prefix)/share/doc/git-doc
|
2007-05-08 12:49:31 +02:00
|
|
|
mandir?=$(prefix)/share/man
|
2006-06-29 23:26:54 +02:00
|
|
|
man1dir=$(mandir)/man1
|
2007-04-20 05:47:04 +02:00
|
|
|
man5dir=$(mandir)/man5
|
2006-06-29 23:26:54 +02:00
|
|
|
man7dir=$(mandir)/man7
|
2005-08-05 01:56:38 +02:00
|
|
|
# DESTDIR=
|
2005-07-15 03:21:57 +02:00
|
|
|
|
2007-02-11 16:54:40 +01:00
|
|
|
ASCIIDOC=asciidoc
|
2007-02-14 00:15:05 +01:00
|
|
|
ASCIIDOC_EXTRA =
|
2005-10-09 00:54:37 +02:00
|
|
|
INSTALL?=install
|
2007-07-14 19:51:44 +02:00
|
|
|
RM ?= rm -f
|
2006-12-23 17:26:09 +01:00
|
|
|
DOC_REF = origin/man
|
2005-07-15 03:21:57 +02:00
|
|
|
|
2007-08-06 12:22:57 +02:00
|
|
|
infodir?=$(prefix)/share/info
|
|
|
|
MAKEINFO=makeinfo
|
|
|
|
INSTALL_INFO=install-info
|
|
|
|
DOCBOOK2X_TEXI=docbook2x-texi
|
2007-12-01 03:36:34 +01:00
|
|
|
ifndef PERL_PATH
|
|
|
|
PERL_PATH = /usr/bin/perl
|
|
|
|
endif
|
2007-08-06 12:22:57 +02:00
|
|
|
|
2006-09-01 00:31:08 +02:00
|
|
|
-include ../config.mak.autogen
|
2007-02-28 21:57:42 +01:00
|
|
|
-include ../config.mak
|
2006-09-01 00:31:08 +02:00
|
|
|
|
2007-11-14 10:38:46 +01:00
|
|
|
ifdef ASCIIDOC8
|
|
|
|
ASCIIDOC_EXTRA += -a asciidoc7compatible
|
|
|
|
endif
|
|
|
|
ifdef DOCBOOK_XSL_172
|
|
|
|
ASCIIDOC_EXTRA += -a docbook-xsl-172
|
|
|
|
endif
|
|
|
|
|
2005-05-22 19:44:15 +02:00
|
|
|
#
|
|
|
|
# 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
|
2005-05-10 23:32:39 +02:00
|
|
|
|
|
|
|
html: $(DOC_HTML)
|
|
|
|
|
2007-04-20 05:47:04 +02:00
|
|
|
$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
|
2005-05-22 19:44:15 +02:00
|
|
|
|
2007-04-20 05:47:04 +02:00
|
|
|
man: man1 man5 man7
|
2005-05-22 19:44:15 +02:00
|
|
|
man1: $(DOC_MAN1)
|
2007-04-20 05:47:04 +02:00
|
|
|
man5: $(DOC_MAN5)
|
2005-05-22 19:44:15 +02:00
|
|
|
man7: $(DOC_MAN7)
|
2005-05-10 23:32:39 +02:00
|
|
|
|
2007-12-10 10:15:57 +01:00
|
|
|
info: git.info gitman.info
|
2007-08-06 12:22:57 +02:00
|
|
|
|
2005-09-21 21:29:59 +02:00
|
|
|
install: man
|
2007-12-01 18:05:40 +01:00
|
|
|
$(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
|
|
|
|
$(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
|
|
|
|
$(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
|
|
|
|
$(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
|
|
|
|
$(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
|
|
|
|
$(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
|
2005-07-15 03:21:57 +02:00
|
|
|
|
2007-08-06 12:22:57 +02:00
|
|
|
install-info: info
|
2007-12-01 18:05:40 +01:00
|
|
|
$(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
|
2007-12-10 10:15:57 +01:00
|
|
|
$(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
|
2007-08-06 12:22:57 +02:00
|
|
|
if test -r $(DESTDIR)$(infodir)/dir; then \
|
|
|
|
$(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
|
2007-12-10 10:15:57 +01:00
|
|
|
$(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
|
2007-08-06 12:22:57 +02:00
|
|
|
else \
|
|
|
|
echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
|
|
|
|
fi
|
2005-11-04 09:06:20 +01:00
|
|
|
|
2007-12-02 06:07:55 +01:00
|
|
|
install-html: html
|
|
|
|
sh ./install-webdoc.sh $(DESTDIR)$(htmldir)
|
|
|
|
|
2007-03-25 13:56:49 +02:00
|
|
|
../GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
|
|
|
|
$(MAKE) -C ../ GIT-VERSION-FILE
|
|
|
|
|
|
|
|
-include ../GIT-VERSION-FILE
|
|
|
|
|
2005-11-07 06:30:56 +01:00
|
|
|
#
|
|
|
|
# Determine "include::" file references in asciidoc files.
|
|
|
|
#
|
2005-11-08 07:21:21 +01:00
|
|
|
doc.dep : $(wildcard *.txt) build-docdep.perl
|
2007-07-14 19:51:44 +02:00
|
|
|
$(RM) $@+ $@
|
2007-12-01 03:36:34 +01:00
|
|
|
$(PERL_PATH) ./build-docdep.perl >$@+
|
2005-11-08 03:21:51 +01:00
|
|
|
mv $@+ $@
|
2005-11-07 06:30:56 +01:00
|
|
|
|
2005-11-08 03:21:51 +01:00
|
|
|
-include doc.dep
|
2005-11-04 09:06:20 +01:00
|
|
|
|
2007-01-19 01:02:13 +01:00
|
|
|
cmds_txt = cmds-ancillaryinterrogators.txt \
|
|
|
|
cmds-ancillarymanipulators.txt \
|
|
|
|
cmds-mainporcelain.txt \
|
|
|
|
cmds-plumbinginterrogators.txt \
|
|
|
|
cmds-plumbingmanipulators.txt \
|
2007-01-19 07:32:38 +01:00
|
|
|
cmds-synchingrepositories.txt \
|
|
|
|
cmds-synchelpers.txt \
|
|
|
|
cmds-purehelpers.txt \
|
|
|
|
cmds-foreignscminterface.txt
|
2007-01-19 01:02:13 +01:00
|
|
|
|
2007-04-06 07:17:20 +02:00
|
|
|
$(cmds_txt): cmd-list.made
|
|
|
|
|
2007-12-02 08:39:19 +01:00
|
|
|
cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
|
2007-08-06 15:05:56 +02:00
|
|
|
$(RM) $@
|
2007-12-01 03:36:34 +01:00
|
|
|
$(PERL_PATH) ./cmd-list.perl ../command-list.txt
|
2007-04-06 07:17:20 +02:00
|
|
|
date >$@
|
2005-05-10 23:32:39 +02:00
|
|
|
|
2007-09-03 06:01:19 +02:00
|
|
|
git.7 git.html: git.txt
|
2005-11-07 06:30:56 +01:00
|
|
|
|
2005-05-10 23:32:39 +02:00
|
|
|
clean:
|
2007-11-25 08:48:04 +01:00
|
|
|
$(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7 *.texi *.texi+ git.info
|
|
|
|
$(RM) howto-index.txt howto/*.html doc.dep
|
|
|
|
$(RM) technical/api-*.html technical/api-index.txt
|
2007-07-14 19:51:44 +02:00
|
|
|
$(RM) $(cmds_txt) *.made
|
2005-05-10 23:32:39 +02:00
|
|
|
|
2007-11-25 08:48:04 +01:00
|
|
|
$(MAN_HTML): %.html : %.txt
|
2007-07-14 19:51:44 +02:00
|
|
|
$(RM) $@+ $@
|
2007-03-25 13:56:49 +02:00
|
|
|
$(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
|
2007-06-01 11:10:30 +02:00
|
|
|
$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $<
|
2007-03-25 13:56:49 +02:00
|
|
|
mv $@+ $@
|
2005-05-10 23:32:39 +02:00
|
|
|
|
2007-04-20 05:47:04 +02:00
|
|
|
%.1 %.5 %.7 : %.xml
|
2007-08-02 01:48:44 +02:00
|
|
|
$(RM) $@
|
2006-04-28 15:15:06 +02:00
|
|
|
xmlto -m callouts.xsl man $<
|
2005-05-10 23:32:39 +02:00
|
|
|
|
|
|
|
%.xml : %.txt
|
2007-07-14 19:51:44 +02:00
|
|
|
$(RM) $@+ $@
|
2007-03-25 13:56:49 +02:00
|
|
|
$(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
|
2007-06-01 11:10:30 +02:00
|
|
|
$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $<
|
2007-03-25 13:56:49 +02:00
|
|
|
mv $@+ $@
|
2005-08-15 02:24:36 +02:00
|
|
|
|
2007-01-08 01:23:49 +01:00
|
|
|
user-manual.xml: user-manual.txt user-manual.conf
|
2007-02-11 16:54:40 +01:00
|
|
|
$(ASCIIDOC) -b docbook -d book $<
|
2007-01-08 01:23:49 +01:00
|
|
|
|
2007-11-25 08:48:04 +01:00
|
|
|
technical/api-index.txt: technical/api-index-skel.txt \
|
|
|
|
technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
|
|
|
|
cd technical && sh ./api-index.sh
|
|
|
|
|
|
|
|
$(patsubst %,%.html,$(API_DOCS) technical/api-index): %.html : %.txt
|
|
|
|
$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
|
|
|
|
$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
|
|
|
|
|
2007-07-24 09:46:35 +02:00
|
|
|
XSLT = docbook.xsl
|
2007-03-16 16:45:29 +01:00
|
|
|
XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
|
2007-03-03 19:33:48 +01:00
|
|
|
|
2007-01-08 01:23:49 +01:00
|
|
|
user-manual.html: user-manual.xml
|
2007-03-03 19:33:48 +01:00
|
|
|
xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
|
2007-01-08 01:23:49 +01:00
|
|
|
|
2007-12-12 22:31:02 +01:00
|
|
|
git.info: user-manual.texi
|
|
|
|
$(MAKEINFO) --no-split -o $@ user-manual.texi
|
2007-12-10 10:15:57 +01:00
|
|
|
|
2007-12-12 22:31:02 +01:00
|
|
|
user-manual.texi: user-manual.xml
|
2007-12-10 10:15:57 +01:00
|
|
|
$(RM) $@+ $@
|
|
|
|
$(DOCBOOK2X_TEXI) user-manual.xml --to-stdout | $(PERL_PATH) fix-texi.perl >$@+
|
|
|
|
mv $@+ $@
|
|
|
|
|
|
|
|
gitman.texi: $(MAN_XML) cat-texi.perl
|
|
|
|
$(RM) $@+ $@
|
|
|
|
($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --to-stdout $(xml);)) | \
|
|
|
|
$(PERL_PATH) cat-texi.perl $@ >$@+
|
|
|
|
mv $@+ $@
|
|
|
|
|
|
|
|
gitman.info: gitman.texi
|
2007-08-06 12:22:57 +02:00
|
|
|
$(MAKEINFO) --no-split $*.texi
|
2007-12-10 10:15:57 +01:00
|
|
|
|
|
|
|
$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
|
|
|
|
$(RM) $@+ $@
|
|
|
|
$(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+
|
|
|
|
mv $@+ $@
|
2007-08-06 12:22:57 +02:00
|
|
|
|
2005-08-25 09:28:18 +02:00
|
|
|
howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
|
2007-07-14 19:51:44 +02:00
|
|
|
$(RM) $@+ $@
|
2005-08-25 09:28:18 +02:00
|
|
|
sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
|
|
|
|
mv $@+ $@
|
|
|
|
|
2005-08-30 22:51:01 +02:00
|
|
|
$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
|
2007-02-11 16:54:40 +01:00
|
|
|
$(ASCIIDOC) -b xhtml11 $*.txt
|
2005-08-25 09:28:18 +02:00
|
|
|
|
|
|
|
WEBDOC_DEST = /pub/software/scm/git/docs
|
|
|
|
|
2005-08-30 07:38:12 +02:00
|
|
|
$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
|
2007-07-14 19:51:44 +02:00
|
|
|
$(RM) $@+ $@
|
2007-02-11 16:54:40 +01:00
|
|
|
sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b xhtml11 - >$@+
|
2005-08-30 07:38:12 +02:00
|
|
|
mv $@+ $@
|
|
|
|
|
2005-08-25 09:28:18 +02:00
|
|
|
install-webdoc : html
|
|
|
|
sh ./install-webdoc.sh $(WEBDOC_DEST)
|
2006-12-23 17:26:09 +01:00
|
|
|
|
|
|
|
quick-install:
|
|
|
|
sh ./install-doc-quick.sh $(DOC_REF) $(mandir)
|
2007-03-25 13:56:49 +02:00
|
|
|
|
|
|
|
.PHONY: .FORCE-GIT-VERSION-FILE
|