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
  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 INSTALL?=install
  35
  36 -include ../config.mak.autogen
  37
  38 #
  39 # Please note that there is a minor bug in asciidoc.
  40 # The version after 6.0.3 _will_ include the patch found here:
  41 #   http://marc.theaimsgroup.com/?l=git&m=111558757202243&w=2
  42 #
  43 # Until that version is released you may have to apply the patch
  44 # yourself - yes, all 6 characters of it!
  45 #
  46
  47 all: html man
  48
  49 html: $(DOC_HTML)
  50
  51 $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN7): asciidoc.conf
  52
  53 man: man1 man7
  54 man1: $(DOC_MAN1)
  55 man7: $(DOC_MAN7)
  56
  57 install: man
  58         $(INSTALL) -d -m755 $(DESTDIR)$(man1dir) $(DESTDIR)$(man7dir)
  59         $(INSTALL) $(DOC_MAN1) $(DESTDIR)$(man1dir)
  60         $(INSTALL) $(DOC_MAN7) $(DESTDIR)$(man7dir)
  61
  62
  63 #
  64 # Determine "include::" file references in asciidoc files.
  65 #
  66 doc.dep : $(wildcard *.txt) build-docdep.perl
  67         rm -f $@+ $@
  68         perl ./build-docdep.perl >$@+
  69         mv $@+ $@
  70
  71 -include doc.dep
  72
  73 git.7: README
  74
  75 README: ../README
  76         cp $< $@
  77
  78
  79 clean:
  80         rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html doc.dep README
  81
  82 %.html : %.txt
  83         asciidoc -b xhtml11 -d manpage -f asciidoc.conf $<
  84
  85 %.1 %.7 : %.xml
  86         xmlto -m callouts.xsl man $<
  87
  88 %.xml : %.txt
  89         asciidoc -b docbook -d manpage -f asciidoc.conf $<
  90
  91 git.html: git.txt README
  92
  93 glossary.html : glossary.txt sort_glossary.pl
  94         cat $< | \
  95         perl sort_glossary.pl | \
  96         asciidoc -b xhtml11 - > glossary.html
  97
  98 howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
  99         rm -f $@+ $@
 100         sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
 101         mv $@+ $@
 102
 103 $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
 104         asciidoc -b xhtml11 $*.txt
 105
 106 WEBDOC_DEST = /pub/software/scm/git/docs
 107
 108 $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
 109         rm -f $@+ $@
 110         sed -e '1,/^$$/d' $< | asciidoc -b xhtml11 - >$@+
 111         mv $@+ $@
 112
 113 install-webdoc : html
 114         sh ./install-webdoc.sh $(WEBDOC_DEST)