Documentation/Makefile

   1 MAN1_TXT= \
   2         $(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
   3                 $(wildcard git-*.txt)) \
   4         gitk.txt
   5 MAN7_TXT=git.txt
   6
   7 DOC_HTML=$(patsubst %.txt,%.html,$(MAN1_TXT) $(MAN7_TXT))
   8
   9 ARTICLES = tutorial
  10 ARTICLES += tutorial-2
  11 ARTICLES += core-tutorial
  12 ARTICLES += cvs-migration
  13 ARTICLES += diffcore
  14 ARTICLES += howto-index
  15 ARTICLES += repository-layout
  16 ARTICLES += hooks
  17 ARTICLES += everyday
  18 ARTICLES += git-tools
  19 # with their own formatting rules.
  20 SP_ARTICLES = glossary howto/revert-branch-rebase user-manual
  21
  22 DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
  23
  24 DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
  25 DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
  26
  27 prefix?=$(HOME)
  28 bindir?=$(prefix)/bin
  29 mandir?=$(prefix)/man
  30 man1dir=$(mandir)/man1
  31 man7dir=$(mandir)/man7
  32 # DESTDIR=
  33
  34 ASCIIDOC=asciidoc
  35 ASCIIDOC_EXTRA =
  36 INSTALL?=install
  37 DOC_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
  51 all: html man
  52
  53 html: $(DOC_HTML)
  54
  55 $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN7): asciidoc.conf
  56
  57 man: man1 man7
  58 man1: $(DOC_MAN1)
  59 man7: $(DOC_MAN7)
  60
  61 install: 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 #
  70 doc.dep : $(wildcard *.txt) build-docdep.perl
  71         rm -f $@+ $@
  72         perl ./build-docdep.perl >$@+
  73         mv $@+ $@
  74
  75 -include doc.dep
  76
  77 cmds_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
  90 git.7 git.html: git.txt core-intro.txt
  91
  92 clean:
  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
 105 user-manual.xml: user-manual.txt user-manual.conf
 106         $(ASCIIDOC) -b docbook -d book $<
 107
 108 XSLT = http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl
 109 XSLTOPTS = --nonet --xinclude --stringparam html.stylesheet docbook-xsl.css
 110
 111 user-manual.html: user-manual.xml
 112         xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
 113
 114 glossary.html : glossary.txt sort_glossary.pl
 115         cat $< | \
 116         perl sort_glossary.pl | \
 117         $(ASCIIDOC) -b xhtml11 - > glossary.html
 118
 119 howto-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
 127 WEBDOC_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
 134 install-webdoc : html
 135         sh ./install-webdoc.sh $(WEBDOC_DEST)
 136
 137 quick-install:
 138         sh ./install-doc-quick.sh $(DOC_REF) $(mandir)