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)
  28bin=$(prefix)/bin
  29mandir=$(prefix)/man
  30man1=$(mandir)/man1
  31man7=$(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
  50man: man1 man7
  51man1: $(DOC_MAN1)
  52man7: $(DOC_MAN7)
  53
  54install: man
  55        $(INSTALL) -d -m755 $(DESTDIR)$(man1) $(DESTDIR)$(man7)
  56        $(INSTALL) $(DOC_MAN1) $(DESTDIR)$(man1)
  57        $(INSTALL) $(DOC_MAN7) $(DESTDIR)$(man7)
  58
  59
  60#
  61# Determine "include::" file references in asciidoc files.
  62#
  63doc.dep : $(wildcard *.txt) build-docdep.perl
  64        rm -f $@+ $@
  65        perl ./build-docdep.perl >$@+
  66        mv $@+ $@
  67
  68-include doc.dep
  69
  70git.7: README
  71
  72README: ../README
  73        cp $< $@
  74
  75
  76clean:
  77        rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html doc.dep README
  78
  79%.html : %.txt
  80        asciidoc -b xhtml11 -d manpage -f asciidoc.conf $<
  81
  82%.1 %.7 : %.xml
  83        xmlto -m callouts.xsl man $<
  84
  85%.xml : %.txt
  86        asciidoc -b docbook -d manpage -f asciidoc.conf $<
  87
  88git.html: git.txt README
  89
  90glossary.html : glossary.txt sort_glossary.pl
  91        cat $< | \
  92        perl sort_glossary.pl | \
  93        asciidoc -b xhtml11 - > glossary.html
  94
  95howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
  96        rm -f $@+ $@
  97        sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
  98        mv $@+ $@
  99
 100$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
 101        asciidoc -b xhtml11 $*.txt
 102
 103WEBDOC_DEST = /pub/software/scm/git/docs
 104
 105$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
 106        rm -f $@+ $@
 107        sed -e '1,/^$$/d' $? | asciidoc -b xhtml11 - >$@+
 108        mv $@+ $@
 109
 110install-webdoc : html
 111        sh ./install-webdoc.sh $(WEBDOC_DEST)