Andrew's git / gitweb.git / Documentation/Makefile
?
Documentation / Makefileon commit fix GIT_TRACE segfault with shell-quoted aliases (27d5438)
   1MAN1_TXT= \
   2        $(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
   3                $(wildcard git-*.txt)) \
   4        gitk.txt git.txt
   5MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt \
   6        gitrepository-layout.txt
   7MAN7_TXT=gitcli.txt gittutorial.txt gittutorial-2.txt \
   8        gitcvs-migration.txt gitcore-tutorial.txt gitglossary.txt \
   9        gitdiffcore.txt
  10
  11MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
  12MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
  13MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
  14
  15DOC_HTML=$(MAN_HTML)
  16
  17ARTICLES = howto-index
  18ARTICLES += everyday
  19ARTICLES += git-tools
  20# with their own formatting rules.
  21SP_ARTICLES = howto/revert-branch-rebase howto/using-merge-subtree user-manual
  22API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
  23SP_ARTICLES += $(API_DOCS)
  24SP_ARTICLES += technical/api-index
  25
  26DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
  27
  28DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
  29DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT))
  30DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
  31
  32prefix?=$(HOME)
  33bindir?=$(prefix)/bin
  34htmldir?=$(prefix)/share/doc/git-doc
  35mandir?=$(prefix)/share/man
  36man1dir=$(mandir)/man1
  37man5dir=$(mandir)/man5
  38man7dir=$(mandir)/man7
  39# DESTDIR=
  40
  41ASCIIDOC=asciidoc
  42ASCIIDOC_EXTRA =
  43MANPAGE_XSL = callouts.xsl
  44INSTALL?=install
  45RM ?= rm -f
  46DOC_REF = origin/man
  47
  48infodir?=$(prefix)/share/info
  49MAKEINFO=makeinfo
  50INSTALL_INFO=install-info
  51DOCBOOK2X_TEXI=docbook2x-texi
  52ifndef PERL_PATH
  53        PERL_PATH = /usr/bin/perl
  54endif
  55
  56-include ../config.mak.autogen
  57-include ../config.mak
  58
  59ifdef ASCIIDOC8
  60ASCIIDOC_EXTRA += -a asciidoc7compatible
  61endif
  62ifdef DOCBOOK_XSL_172
  63ASCIIDOC_EXTRA += -a docbook-xsl-172
  64MANPAGE_XSL = manpage-1.72.xsl
  65endif
  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
  76all: html man
  77
  78html: $(DOC_HTML)
  79
  80$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
  81
  82man: man1 man5 man7
  83man1: $(DOC_MAN1)
  84man5: $(DOC_MAN5)
  85man7: $(DOC_MAN7)
  86
  87info: git.info gitman.info
  88
  89install: 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
  97install-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
 107install-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#
 118doc.dep : $(wildcard *.txt) build-docdep.perl
 119        $(RM) $@+ $@
 120        $(PERL_PATH) ./build-docdep.perl >$@+
 121        mv $@+ $@
 122
 123-include doc.dep
 124
 125cmds_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
 137cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
 138        $(RM) $@
 139        $(PERL_PATH) ./cmd-list.perl ../command-list.txt
 140        date >$@
 141
 142clean:
 143        $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
 144        $(RM) *.texi *.texi+ git.info gitman.info
 145        $(RM) howto-index.txt howto/*.html doc.dep
 146        $(RM) technical/api-*.html technical/api-index.txt
 147        $(RM) $(cmds_txt) *.made
 148
 149$(MAN_HTML): %.html : %.txt
 150        $(RM) $@+ $@
 151        $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
 152                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $<
 153        mv $@+ $@
 154
 155%.1 %.5 %.7 : %.xml
 156        $(RM) $@
 157        xmlto -m $(MANPAGE_XSL) man $<
 158
 159%.xml : %.txt
 160        $(RM) $@+ $@
 161        $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
 162                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $<
 163        mv $@+ $@
 164
 165user-manual.xml: user-manual.txt user-manual.conf
 166        $(ASCIIDOC) -b docbook -d book $<
 167
 168technical/api-index.txt: technical/api-index-skel.txt \
 169        technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
 170        cd technical && sh ./api-index.sh
 171
 172$(patsubst %,%.html,$(API_DOCS) technical/api-index): %.html : %.txt
 173        $(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
 174                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
 175
 176XSLT = docbook.xsl
 177XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
 178
 179user-manual.html: user-manual.xml
 180        xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
 181
 182git.info: user-manual.texi
 183        $(MAKEINFO) --no-split -o $@ user-manual.texi
 184
 185user-manual.texi: user-manual.xml
 186        $(RM) $@+ $@
 187        $(DOCBOOK2X_TEXI) user-manual.xml --to-stdout | $(PERL_PATH) fix-texi.perl >$@+
 188        mv $@+ $@
 189
 190gitman.texi: $(MAN_XML) cat-texi.perl
 191        $(RM) $@+ $@
 192        ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --to-stdout $(xml);)) | \
 193        $(PERL_PATH) cat-texi.perl $@ >$@+
 194        mv $@+ $@
 195
 196gitman.info: gitman.texi
 197        $(MAKEINFO) --no-split $*.texi
 198
 199$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
 200        $(RM) $@+ $@
 201        $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+
 202        mv $@+ $@
 203
 204howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
 205        $(RM) $@+ $@
 206        sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
 207        mv $@+ $@
 208
 209$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
 210        $(ASCIIDOC) -b xhtml11 $*.txt
 211
 212WEBDOC_DEST = /pub/software/scm/git/docs
 213
 214$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
 215        $(RM) $@+ $@
 216        sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b xhtml11 - >$@+
 217        mv $@+ $@
 218
 219install-webdoc : html
 220        sh ./install-webdoc.sh $(WEBDOC_DEST)
 221
 222quick-install:
 223        sh ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)
 224
 225.PHONY: .FORCE-GIT-VERSION-FILE