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 user-manual
  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
  34ASCIIDOC=asciidoc
  35ASCIIDOC_EXTRA =
  36INSTALL?=install
  37DOC_REF = origin/man
  38
  39-include ../config.mak.autogen
  40-include ../config.mak
  41
  42#
  43# Please note that there is a minor bug in asciidoc.
  44# The version after 6.0.3 _will_ include the patch found here:
  45#   http://marc.theaimsgroup.com/?l=git&m=111558757202243&w=2
  46#
  47# Until that version is released you may have to apply the patch
  48# yourself - yes, all 6 characters of it!
  49#
  50
  51all: html man
  52
  53html: $(DOC_HTML)
  54
  55$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN7): asciidoc.conf
  56
  57man: man1 man7
  58man1: $(DOC_MAN1)
  59man7: $(DOC_MAN7)
  60
  61install: man
  62        $(INSTALL) -d -m755 $(DESTDIR)$(man1dir) $(DESTDIR)$(man7dir)
  63        $(INSTALL) -m644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
  64        $(INSTALL) -m644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
  65
  66
  67#
  68# Determine "include::" file references in asciidoc files.
  69#
  70doc.dep : $(wildcard *.txt) build-docdep.perl
  71        rm -f $@+ $@
  72        perl ./build-docdep.perl >$@+
  73        mv $@+ $@
  74
  75-include doc.dep
  76
  77cmds_txt = cmds-ancillaryinterrogators.txt \
  78        cmds-ancillarymanipulators.txt \
  79        cmds-mainporcelain.txt \
  80        cmds-plumbinginterrogators.txt \
  81        cmds-plumbingmanipulators.txt \
  82        cmds-synchingrepositories.txt \
  83        cmds-synchelpers.txt \
  84        cmds-purehelpers.txt \
  85        cmds-foreignscminterface.txt
  86
  87$(cmds_txt): cmd-list.perl $(MAN1_TXT)
  88        perl ./cmd-list.perl
  89
  90git.7 git.html: git.txt core-intro.txt
  91
  92clean:
  93        rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html doc.dep
  94        rm -f $(cmds_txt)
  95
  96%.html : %.txt
  97        $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf $(ASCIIDOC_EXTRA) $<
  98
  99%.1 %.7 : %.xml
 100        xmlto -m callouts.xsl man $<
 101
 102%.xml : %.txt
 103        $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf $<
 104
 105user-manual.xml: user-manual.txt user-manual.conf
 106        $(ASCIIDOC) -b docbook -d book $<
 107
 108XSLT = http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl
 109XSLTOPTS = --nonet --xinclude --stringparam html.stylesheet docbook-xsl.css
 110
 111user-manual.html: user-manual.xml
 112        xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
 113
 114glossary.html : glossary.txt sort_glossary.pl
 115        cat $< | \
 116        perl sort_glossary.pl | \
 117        $(ASCIIDOC) -b xhtml11 - > glossary.html
 118
 119howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
 120        rm -f $@+ $@
 121        sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
 122        mv $@+ $@
 123
 124$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
 125        $(ASCIIDOC) -b xhtml11 $*.txt
 126
 127WEBDOC_DEST = /pub/software/scm/git/docs
 128
 129$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
 130        rm -f $@+ $@
 131        sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b xhtml11 - >$@+
 132        mv $@+ $@
 133
 134install-webdoc : html
 135        sh ./install-webdoc.sh $(WEBDOC_DEST)
 136
 137quick-install:
 138        sh ./install-doc-quick.sh $(DOC_REF) $(mandir)