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