Documentation/Makefile

   1 MAN1_TXT= \
   2         $(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
   3                 $(wildcard git-*.txt)) \
   4         gitk.txt
   5 MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt
   6 MAN7_TXT=git.txt gitcli.txt gittutorial.txt gittutorial-2.txt \
   7         gitcvs-migration.txt gitcore-tutorial.txt gitglossary.txt
   8
   9 MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
  10 MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
  11 MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
  12
  13 DOC_HTML=$(MAN_HTML)
  14
  15 ARTICLES = diffcore
  16 ARTICLES += howto-index
  17 ARTICLES += repository-layout
  18 ARTICLES += everyday
  19 ARTICLES += git-tools
  20 # with their own formatting rules.
  21 SP_ARTICLES = howto/revert-branch-rebase howto/using-merge-subtree user-manual
  22 API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
  23 SP_ARTICLES += $(API_DOCS)
  24 SP_ARTICLES += technical/api-index
  25
  26 DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
  27
  28 DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
  29 DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT))
  30 DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
  31
  32 prefix?=$(HOME)
  33 bindir?=$(prefix)/bin
  34 htmldir?=$(prefix)/share/doc/git-doc
  35 mandir?=$(prefix)/share/man
  36 man1dir=$(mandir)/man1
  37 man5dir=$(mandir)/man5
  38 man7dir=$(mandir)/man7
  39 # DESTDIR=
  40
  41 ASCIIDOC=asciidoc
  42 ASCIIDOC_EXTRA =
  43 MANPAGE_XSL = callouts.xsl
  44 INSTALL?=install
  45 RM ?= rm -f
  46 DOC_REF = origin/man
  47
  48 infodir?=$(prefix)/share/info
  49 MAKEINFO=makeinfo
  50 INSTALL_INFO=install-info
  51 DOCBOOK2X_TEXI=docbook2x-texi
  52 ifndef PERL_PATH
  53         PERL_PATH = /usr/bin/perl
  54 endif
  55
  56 -include ../config.mak.autogen
  57 -include ../config.mak
  58
  59 ifdef ASCIIDOC8
  60 ASCIIDOC_EXTRA += -a asciidoc7compatible
  61 endif
  62 ifdef DOCBOOK_XSL_172
  63 ASCIIDOC_EXTRA += -a docbook-xsl-172
  64 MANPAGE_XSL = manpage-1.72.xsl
  65 endif
  66
  67 #
  68 # Please note that there is a minor bug in asciidoc.
  69 # The version after 6.0.3 _will_ include the patch found here:
  70 #   http://marc.theaimsgroup.com/?l=git&m=111558757202243&w=2
  71 #
  72 # Until that version is released you may have to apply the patch
  73 # yourself - yes, all 6 characters of it!
  74 #
  75
  76 all: html man
  77
  78 html: $(DOC_HTML)
  79
  80 $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
  81
  82 man: man1 man5 man7
  83 man1: $(DOC_MAN1)
  84 man5: $(DOC_MAN5)
  85 man7: $(DOC_MAN7)
  86
  87 info: git.info gitman.info
  88
  89 install: man
  90         $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
  91         $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
  92         $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
  93         $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
  94         $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
  95         $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
  96
  97 install-info: info
  98         $(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
  99         $(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
 100         if test -r $(DESTDIR)$(infodir)/dir; then \
 101           $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
 102           $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
 103         else \
 104           echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
 105         fi
 106
 107 install-html: html
 108         sh ./install-webdoc.sh $(DESTDIR)$(htmldir)
 109
 110 ../GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
 111         $(MAKE) -C ../ GIT-VERSION-FILE
 112
 113 -include ../GIT-VERSION-FILE
 114
 115 #
 116 # Determine "include::" file references in asciidoc files.
 117 #
 118 doc.dep : $(wildcard *.txt) build-docdep.perl
 119         $(RM) $@+ $@
 120         $(PERL_PATH) ./build-docdep.perl >$@+
 121         mv $@+ $@
 122
 123 -include doc.dep
 124
 125 cmds_txt = cmds-ancillaryinterrogators.txt \
 126         cmds-ancillarymanipulators.txt \
 127         cmds-mainporcelain.txt \
 128         cmds-plumbinginterrogators.txt \
 129         cmds-plumbingmanipulators.txt \
 130         cmds-synchingrepositories.txt \
 131         cmds-synchelpers.txt \
 132         cmds-purehelpers.txt \
 133         cmds-foreignscminterface.txt
 134
 135 $(cmds_txt): cmd-list.made
 136
 137 cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
 138         $(RM) $@
 139         $(PERL_PATH) ./cmd-list.perl ../command-list.txt
 140         date >$@
 141
 142 git.7 git.html: git.txt
 143
 144 clean:
 145         $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
 146         $(RM) *.texi *.texi+ git.info gitman.info
 147         $(RM) howto-index.txt howto/*.html doc.dep
 148         $(RM) technical/api-*.html technical/api-index.txt
 149         $(RM) $(cmds_txt) *.made
 150
 151 $(MAN_HTML): %.html : %.txt
 152         $(RM) $@+ $@
 153         $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
 154                 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $<
 155         mv $@+ $@
 156
 157 %.1 %.5 %.7 : %.xml
 158         $(RM) $@
 159         xmlto -m $(MANPAGE_XSL) man $<
 160
 161 %.xml : %.txt
 162         $(RM) $@+ $@
 163         $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
 164                 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $<
 165         mv $@+ $@
 166
 167 user-manual.xml: user-manual.txt user-manual.conf
 168         $(ASCIIDOC) -b docbook -d book $<
 169
 170 technical/api-index.txt: technical/api-index-skel.txt \
 171         technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
 172         cd technical && sh ./api-index.sh
 173
 174 $(patsubst %,%.html,$(API_DOCS) technical/api-index): %.html : %.txt
 175         $(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
 176                 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
 177
 178 XSLT = docbook.xsl
 179 XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
 180
 181 user-manual.html: user-manual.xml
 182         xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
 183
 184 git.info: user-manual.texi
 185         $(MAKEINFO) --no-split -o $@ user-manual.texi
 186
 187 user-manual.texi: user-manual.xml
 188         $(RM) $@+ $@
 189         $(DOCBOOK2X_TEXI) user-manual.xml --to-stdout | $(PERL_PATH) fix-texi.perl >$@+
 190         mv $@+ $@
 191
 192 gitman.texi: $(MAN_XML) cat-texi.perl
 193         $(RM) $@+ $@
 194         ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --to-stdout $(xml);)) | \
 195         $(PERL_PATH) cat-texi.perl $@ >$@+
 196         mv $@+ $@
 197
 198 gitman.info: gitman.texi
 199         $(MAKEINFO) --no-split $*.texi
 200
 201 $(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
 202         $(RM) $@+ $@
 203         $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+
 204         mv $@+ $@
 205
 206 howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
 207         $(RM) $@+ $@
 208         sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
 209         mv $@+ $@
 210
 211 $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
 212         $(ASCIIDOC) -b xhtml11 $*.txt
 213
 214 WEBDOC_DEST = /pub/software/scm/git/docs
 215
 216 $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
 217         $(RM) $@+ $@
 218         sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b xhtml11 - >$@+
 219         mv $@+ $@
 220
 221 install-webdoc : html
 222         sh ./install-webdoc.sh $(WEBDOC_DEST)
 223
 224 quick-install:
 225         sh ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)
 226
 227 .PHONY: .FORCE-GIT-VERSION-FILE