Documentation/Makefile

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