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 ARTICLES += glossary
  20 # with their own formatting rules.
  21 SP_ARTICLES = howto/revert-branch-rebase user-manual
  22
  23 DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
  24
  25 DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
  26 DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
  27
  28 prefix?=$(HOME)
  29 bindir?=$(prefix)/bin
  30 mandir?=$(prefix)/man
  31 man1dir=$(mandir)/man1
  32 man7dir=$(mandir)/man7
  33 # DESTDIR=
  34
  35 ASCIIDOC=asciidoc
  36 ASCIIDOC_EXTRA =
  37 INSTALL?=install
  38 DOC_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
  52 all: html man
  53
  54 html: $(DOC_HTML)
  55
  56 $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN7): asciidoc.conf
  57
  58 man: man1 man7
  59 man1: $(DOC_MAN1)
  60 man7: $(DOC_MAN7)
  61
  62 install: 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 ../GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
  69         $(MAKE) -C ../ GIT-VERSION-FILE
  70
  71 -include ../GIT-VERSION-FILE
  72
  73 #
  74 # Determine "include::" file references in asciidoc files.
  75 #
  76 doc.dep : $(wildcard *.txt) build-docdep.perl
  77         rm -f $@+ $@
  78         perl ./build-docdep.perl >$@+
  79         mv $@+ $@
  80
  81 -include doc.dep
  82
  83 cmds_txt = cmds-ancillaryinterrogators.txt \
  84         cmds-ancillarymanipulators.txt \
  85         cmds-mainporcelain.txt \
  86         cmds-plumbinginterrogators.txt \
  87         cmds-plumbingmanipulators.txt \
  88         cmds-synchingrepositories.txt \
  89         cmds-synchelpers.txt \
  90         cmds-purehelpers.txt \
  91         cmds-foreignscminterface.txt
  92
  93 $(cmds_txt): cmd-list.made
  94
  95 cmd-list.made: cmd-list.perl $(MAN1_TXT)
  96         perl ./cmd-list.perl
  97         date >$@
  98
  99 git.7 git.html: git.txt core-intro.txt
 100
 101 clean:
 102         rm -f *.xml *.xml+ *.html *.html+ *.1 *.7 howto-index.txt howto/*.html doc.dep
 103         rm -f $(cmds_txt) *.made
 104
 105 %.html : %.txt
 106         rm -f $@+ $@
 107         $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
 108                 $(ASCIIDOC_EXTRA) -o - $< | \
 109                 sed -e 's/@@GIT_VERSION@@/$(GIT_VERSION)/g' >$@+
 110         mv $@+ $@
 111
 112 %.1 %.7 : %.xml
 113         xmlto -m callouts.xsl man $<
 114
 115 %.xml : %.txt
 116         rm -f $@+ $@
 117         $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
 118                 $(ASCIIDOC_EXTRA) -o - $< | \
 119                 sed -e 's/@@GIT_VERSION@@/$(GIT_VERSION)/g' >$@+
 120         mv $@+ $@
 121
 122 user-manual.xml: user-manual.txt user-manual.conf
 123         $(ASCIIDOC) -b docbook -d book $<
 124
 125 XSLT = http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl
 126 XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
 127
 128 user-manual.html: user-manual.xml
 129         xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
 130
 131 howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
 132         rm -f $@+ $@
 133         sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
 134         mv $@+ $@
 135
 136 $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
 137         $(ASCIIDOC) -b xhtml11 $*.txt
 138
 139 WEBDOC_DEST = /pub/software/scm/git/docs
 140
 141 $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
 142         rm -f $@+ $@
 143         sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b xhtml11 - >$@+
 144         mv $@+ $@
 145
 146 install-webdoc : html
 147         sh ./install-webdoc.sh $(WEBDOC_DEST)
 148
 149 quick-install:
 150         sh ./install-doc-quick.sh $(DOC_REF) $(mandir)
 151
 152 .PHONY: .FORCE-GIT-VERSION-FILE