Start RelNotes for 1.5.4
[gitweb.git] / Documentation / Makefile
index 3f92783d55b401a5c919f7c9176a12953d0c4904..39ec0ede0249da79be574d85e731f8a7b239d9db 100644 (file)
@@ -2,7 +2,7 @@ MAN1_TXT= \
        $(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
                $(wildcard git-*.txt)) \
        gitk.txt
-MAN5_TXT=gitattributes.txt
+MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt
 MAN7_TXT=git.txt
 
 DOC_HTML=$(patsubst %.txt,%.html,$(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT))
@@ -29,7 +29,7 @@ DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
 
 prefix?=$(HOME)
 bindir?=$(prefix)/bin
-mandir?=$(prefix)/man
+mandir?=$(prefix)/share/man
 man1dir=$(mandir)/man1
 man5dir=$(mandir)/man5
 man7dir=$(mandir)/man7
@@ -37,9 +37,18 @@ man7dir=$(mandir)/man7
 
 ASCIIDOC=asciidoc
 ASCIIDOC_EXTRA =
+ifdef ASCIIDOC8
+ASCIIDOC_EXTRA += -a asciidoc7compatible
+endif
 INSTALL?=install
+RM ?= rm -f
 DOC_REF = origin/man
 
+infodir?=$(prefix)/share/info
+MAKEINFO=makeinfo
+INSTALL_INFO=install-info
+DOCBOOK2X_TEXI=docbook2x-texi
+
 -include ../config.mak.autogen
 -include ../config.mak
 
@@ -63,6 +72,8 @@ man1: $(DOC_MAN1)
 man5: $(DOC_MAN5)
 man7: $(DOC_MAN7)
 
+info: git.info
+
 install: man
        $(INSTALL) -d -m755 $(DESTDIR)$(man1dir)
        $(INSTALL) -d -m755 $(DESTDIR)$(man5dir)
@@ -71,6 +82,14 @@ install: man
        $(INSTALL) -m644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
        $(INSTALL) -m644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
 
+install-info: info
+       $(INSTALL) -d -m755 $(DESTDIR)$(infodir)
+       $(INSTALL) -m644 git.info $(DESTDIR)$(infodir)
+       if test -r $(DESTDIR)$(infodir)/dir; then \
+         $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
+       else \
+         echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
+       fi
 
 ../GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
        $(MAKE) -C ../ GIT-VERSION-FILE
@@ -81,7 +100,7 @@ install: man
 # Determine "include::" file references in asciidoc files.
 #
 doc.dep : $(wildcard *.txt) build-docdep.perl
-       rm -f $@+ $@
+       $(RM) $@+ $@
        perl ./build-docdep.perl >$@+
        mv $@+ $@
 
@@ -100,43 +119,50 @@ cmds_txt = cmds-ancillaryinterrogators.txt \
 $(cmds_txt): cmd-list.made
 
 cmd-list.made: cmd-list.perl $(MAN1_TXT)
+       $(RM) $@
        perl ./cmd-list.perl
        date >$@
 
-git.7 git.html: git.txt core-intro.txt
+git.7 git.html: git.txt
 
 clean:
-       rm -f *.xml *.xml+ *.html *.html+ *.1 *.5 *.7 howto-index.txt howto/*.html doc.dep
-       rm -f $(cmds_txt) *.made
+       $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7 *.texi *.texi+ howto-index.txt howto/*.html doc.dep
+       $(RM) $(cmds_txt) *.made
 
 %.html : %.txt
-       rm -f $@+ $@
+       $(RM) $@+ $@
        $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
-               $(ASCIIDOC_EXTRA) -o - $< | \
-               sed -e 's/@@GIT_VERSION@@/$(GIT_VERSION)/g' >$@+
+               $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $<
        mv $@+ $@
 
 %.1 %.5 %.7 : %.xml
+       $(RM) $@
        xmlto -m callouts.xsl man $<
 
 %.xml : %.txt
-       rm -f $@+ $@
+       $(RM) $@+ $@
        $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
-               $(ASCIIDOC_EXTRA) -o - $< | \
-               sed -e 's/@@GIT_VERSION@@/$(GIT_VERSION)/g' >$@+
+               $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $<
        mv $@+ $@
 
 user-manual.xml: user-manual.txt user-manual.conf
        $(ASCIIDOC) -b docbook -d book $<
 
-XSLT = http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl
+XSLT = docbook.xsl
 XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
 
 user-manual.html: user-manual.xml
        xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
 
+git.info: user-manual.xml
+       $(RM) $@ $*.texi $*.texi+
+       $(DOCBOOK2X_TEXI) user-manual.xml --to-stdout >$*.texi+
+       perl fix-texi.perl <$*.texi+ >$*.texi
+       $(MAKEINFO) --no-split $*.texi
+       $(RM) $*.texi $*.texi+
+
 howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
-       rm -f $@+ $@
+       $(RM) $@+ $@
        sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
        mv $@+ $@
 
@@ -146,7 +172,7 @@ $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
 WEBDOC_DEST = /pub/software/scm/git/docs
 
 $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
-       rm -f $@+ $@
+       $(RM) $@+ $@
        sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b xhtml11 - >$@+
        mv $@+ $@