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

   1MAN1_TXT=$(wildcard git-*.txt) gitk.txt
   2MAN7_TXT=git.txt
   3
   4DOC_HTML=$(patsubst %.txt,%.html,$(MAN1_TXT) $(MAN7_TXT))
   5
   6ARTICLES = tutorial
   7ARTICLES += cvs-migration
   8ARTICLES += diffcore
   9ARTICLES += howto-index
  10ARTICLES += repository-layout
  11ARTICLES += hooks
  12ARTICLES += everyday
  13# with their own formatting rules.
  14SP_ARTICLES = glossary howto/revert-branch-rebase
  15
  16DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
  17
  18DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
  19DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
  20
  21prefix?=$(HOME)
  22bin=$(prefix)/bin
  23mandir=$(prefix)/man
  24man1=$(mandir)/man1
  25man7=$(mandir)/man7
  26# DESTDIR=
  27
  28INSTALL?=install
  29
  30#
  31# Please note that there is a minor bug in asciidoc.
  32# The version after 6.0.3 _will_ include the patch found here:
  33#   http://marc.theaimsgroup.com/?l=git&m=111558757202243&w=2
  34#
  35# Until that version is released you may have to apply the patch
  36# yourself - yes, all 6 characters of it!
  37#
  38
  39all: html man
  40
  41html: $(DOC_HTML)
  42
  43
  44man: man1 man7
  45man1: $(DOC_MAN1)
  46man7: $(DOC_MAN7)
  47
  48install: man
  49        $(INSTALL) -d -m755 $(DESTDIR)/$(man1) $(DESTDIR)/$(man7)
  50        $(INSTALL) $(DOC_MAN1) $(DESTDIR)/$(man1)
  51        $(INSTALL) $(DOC_MAN7) $(DESTDIR)/$(man7)
  52
  53
  54#
  55# Determine "include::" file references in asciidoc files.
  56#
  57doc.dep : $(wildcard *.txt) build-docdep.perl
  58        rm -f $@+ $@
  59        perl ./build-docdep.perl >$@+
  60        mv $@+ $@
  61
  62-include doc.dep
  63
  64git.7: ../README
  65
  66
  67clean:
  68        rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html doc.dep
  69
  70%.html : %.txt
  71        asciidoc -b xhtml11 -d manpage -f asciidoc.conf $<
  72
  73%.1 %.7 : %.xml
  74        xmlto man $<
  75
  76%.xml : %.txt
  77        asciidoc -b docbook -d manpage -f asciidoc.conf $<
  78
  79git.html: git.txt ../README
  80
  81glossary.html : glossary.txt sort_glossary.pl
  82        cat $< | \
  83        perl sort_glossary.pl | \
  84        asciidoc -b xhtml11 - > glossary.html
  85
  86howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
  87        rm -f $@+ $@
  88        sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
  89        mv $@+ $@
  90
  91$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
  92        asciidoc -b xhtml11 $*.txt
  93
  94WEBDOC_DEST = /pub/software/scm/git/docs
  95
  96$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
  97        rm -f $@+ $@
  98        sed -e '1,/^$$/d' $? | asciidoc -b xhtml11 - >$@+
  99        mv $@+ $@
 100
 101install-webdoc : html
 102        sh ./install-webdoc.sh $(WEBDOC_DEST)