Andrew's git - gitweb.git/blob - Documentation/Makefile

   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
  35
  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
  45all: html man
  46
  47html: $(DOC_HTML)
  48
  49$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN7): asciidoc.conf
  50
  51man: man1 man7
  52man1: $(DOC_MAN1)
  53man7: $(DOC_MAN7)
  54
  55install: man
  56        $(INSTALL) -d -m755 $(DESTDIR)$(man1dir) $(DESTDIR)$(man7dir)
  57        $(INSTALL) $(DOC_MAN1) $(DESTDIR)$(man1dir)
  58        $(INSTALL) $(DOC_MAN7) $(DESTDIR)$(man7dir)
  59
  60
  61#
  62# Determine "include::" file references in asciidoc files.
  63#
  64doc.dep : $(wildcard *.txt) build-docdep.perl
  65        rm -f $@+ $@
  66        perl ./build-docdep.perl >$@+
  67        mv $@+ $@
  68
  69-include doc.dep
  70
  71git.7: README
  72
  73README: ../README
  74        cp $< $@
  75
  76
  77clean:
  78        rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html doc.dep README
  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
  89git.html: git.txt README
  90
  91glossary.html : glossary.txt sort_glossary.pl
  92        cat $< | \
  93        perl sort_glossary.pl | \
  94        asciidoc -b xhtml11 - > glossary.html
  95
  96howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
  97        rm -f $@+ $@
  98        sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
  99        mv $@+ $@
 100
 101$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
 102        asciidoc -b xhtml11 $*.txt
 103
 104WEBDOC_DEST = /pub/software/scm/git/docs
 105
 106$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
 107        rm -f $@+ $@
 108        sed -e '1,/^$$/d' $? | asciidoc -b xhtml11 - >$@+
 109        mv $@+ $@
 110
 111install-webdoc : html
 112        sh ./install-webdoc.sh $(WEBDOC_DEST)