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