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