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