Andrew's git - gitweb.git/blob

dae31746675ce2699204ad5645e03785469a16c2
   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 gitworkflows.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
  35pdfdir?=$(prefix)/share/doc/git-doc
  36mandir?=$(prefix)/share/man
  37man1dir=$(mandir)/man1
  38man5dir=$(mandir)/man5
  39man7dir=$(mandir)/man7
  40# DESTDIR=
  41
  42ASCIIDOC=asciidoc
  43ASCIIDOC_EXTRA =
  44MANPAGE_XSL = manpage-normal.xsl
  45XMLTO_EXTRA =
  46INSTALL?=install
  47RM ?= rm -f
  48DOC_REF = origin/man
  49HTML_REF = origin/html
  50
  51infodir?=$(prefix)/share/info
  52MAKEINFO=makeinfo
  53INSTALL_INFO=install-info
  54DOCBOOK2X_TEXI=docbook2x-texi
  55DBLATEX=dblatex
  56ifndef PERL_PATH
  57        PERL_PATH = /usr/bin/perl
  58endif
  59
  60-include ../config.mak.autogen
  61-include ../config.mak
  62
  63#
  64# For asciidoc ...
  65#       -7.1.2, no extra settings are needed.
  66#       8.0-,   set ASCIIDOC8.
  67#
  68
  69#
  70# For docbook-xsl ...
  71#       -1.68.1,        set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0)
  72#       1.69.0-1.71.1,  no extra settings are needed?
  73#       1.72.0,         set DOCBOOK_XSL_172.
  74#       1.73.0-,        set ASCIIDOC_NO_ROFF
  75#
  76
  77#
  78# If you had been using DOCBOOK_XSL_172 in an attempt to get rid
  79# of 'the ".ft C" problem' in your generated manpages, and you
  80# instead ended up with weird characters around callouts, try
  81# using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8).
  82#
  83
  84ifdef ASCIIDOC8
  85ASCIIDOC_EXTRA += -a asciidoc7compatible
  86endif
  87ifdef DOCBOOK_XSL_172
  88ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
  89MANPAGE_XSL = manpage-1.72.xsl
  90else
  91        ifdef ASCIIDOC_NO_ROFF
  92        # docbook-xsl after 1.72 needs the regular XSL, but will not
  93        # pass-thru raw roff codes from asciidoc.conf, so turn them off.
  94        ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
  95        endif
  96endif
  97ifdef MAN_BOLD_LITERAL
  98XMLTO_EXTRA += -m manpage-bold-literal.xsl
  99endif
 100
 101#
 102# Please note that there is a minor bug in asciidoc.
 103# The version after 6.0.3 _will_ include the patch found here:
 104#   http://marc.theaimsgroup.com/?l=git&m=111558757202243&w=2
 105#
 106# Until that version is released you may have to apply the patch
 107# yourself - yes, all 6 characters of it!
 108#
 109
 110QUIET_SUBDIR0  = +$(MAKE) -C # space to separate -C and subdir
 111QUIET_SUBDIR1  =
 112
 113ifneq ($(findstring $(MAKEFLAGS),w),w)
 114PRINT_DIR = --no-print-directory
 115else # "make -w"
 116NO_SUBDIR = :
 117endif
 118
 119ifneq ($(findstring $(MAKEFLAGS),s),s)
 120ifndef V
 121        QUIET_ASCIIDOC  = @echo '   ' ASCIIDOC $@;
 122        QUIET_XMLTO     = @echo '   ' XMLTO $@;
 123        QUIET_DB2TEXI   = @echo '   ' DB2TEXI $@;
 124        QUIET_MAKEINFO  = @echo '   ' MAKEINFO $@;
 125        QUIET_DBLATEX   = @echo '   ' DBLATEX $@;
 126        QUIET_XSLTPROC  = @echo '   ' XSLTPROC $@;
 127        QUIET_GEN       = @echo '   ' GEN $@;
 128        QUIET_STDERR    = 2> /dev/null
 129        QUIET_SUBDIR0   = +@subdir=
 130        QUIET_SUBDIR1   = ;$(NO_SUBDIR) echo '   ' SUBDIR $$subdir; \
 131                          $(MAKE) $(PRINT_DIR) -C $$subdir
 132        export V
 133endif
 134endif
 135
 136all: html man
 137
 138html: $(DOC_HTML)
 139
 140$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
 141
 142man: man1 man5 man7
 143man1: $(DOC_MAN1)
 144man5: $(DOC_MAN5)
 145man7: $(DOC_MAN7)
 146
 147info: git.info gitman.info
 148
 149pdf: user-manual.pdf
 150
 151install: install-man
 152
 153install-man: man
 154        $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
 155        $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
 156        $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
 157        $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
 158        $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
 159        $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
 160
 161install-info: info
 162        $(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
 163        $(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
 164        if test -r $(DESTDIR)$(infodir)/dir; then \
 165          $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
 166          $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
 167        else \
 168          echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
 169        fi
 170
 171install-pdf: pdf
 172        $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
 173        $(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)
 174
 175install-html: html
 176        sh ./install-webdoc.sh $(DESTDIR)$(htmldir)
 177
 178../GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
 179        $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
 180
 181-include ../GIT-VERSION-FILE
 182
 183#
 184# Determine "include::" file references in asciidoc files.
 185#
 186doc.dep : $(wildcard *.txt) build-docdep.perl
 187        $(QUIET_GEN)$(RM) $@+ $@ && \
 188        $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
 189        mv $@+ $@
 190
 191-include doc.dep
 192
 193cmds_txt = cmds-ancillaryinterrogators.txt \
 194        cmds-ancillarymanipulators.txt \
 195        cmds-mainporcelain.txt \
 196        cmds-plumbinginterrogators.txt \
 197        cmds-plumbingmanipulators.txt \
 198        cmds-synchingrepositories.txt \
 199        cmds-synchelpers.txt \
 200        cmds-purehelpers.txt \
 201        cmds-foreignscminterface.txt
 202
 203$(cmds_txt): cmd-list.made
 204
 205cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
 206        $(QUIET_GEN)$(RM) $@ && \
 207        $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
 208        date >$@
 209
 210clean:
 211        $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
 212        $(RM) *.texi *.texi+ *.texi++ git.info gitman.info
 213        $(RM) howto-index.txt howto/*.html doc.dep
 214        $(RM) technical/api-*.html technical/api-index.txt
 215        $(RM) $(cmds_txt) *.made
 216
 217$(MAN_HTML): %.html : %.txt
 218        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 219        $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
 220                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
 221        mv $@+ $@
 222
 223%.1 %.5 %.7 : %.xml
 224        $(QUIET_XMLTO)$(RM) $@ && \
 225        xmlto -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
 226
 227%.xml : %.txt
 228        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 229        $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
 230                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
 231        mv $@+ $@
 232
 233user-manual.xml: user-manual.txt user-manual.conf
 234        $(QUIET_ASCIIDOC)$(ASCIIDOC) -b docbook -d book $<
 235
 236technical/api-index.txt: technical/api-index-skel.txt \
 237        technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
 238        $(QUIET_GEN)cd technical && sh ./api-index.sh
 239
 240$(patsubst %,%.html,$(API_DOCS) technical/api-index): %.html : %.txt
 241        $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
 242                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
 243
 244XSLT = docbook.xsl
 245XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
 246
 247user-manual.html: user-manual.xml
 248        $(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
 249
 250git.info: user-manual.texi
 251        $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
 252
 253user-manual.texi: user-manual.xml
 254        $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
 255        $(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
 256        $(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
 257        rm $@++ && \
 258        mv $@+ $@
 259
 260user-manual.pdf: user-manual.xml
 261        $(QUIET_DBLATEX)$(RM) $@+ $@ && \
 262        $(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $< && \
 263        mv $@+ $@
 264
 265gitman.texi: $(MAN_XML) cat-texi.perl
 266        $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
 267        ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
 268                --to-stdout $(xml) &&) true) > $@++ && \
 269        $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
 270        rm $@++ && \
 271        mv $@+ $@
 272
 273gitman.info: gitman.texi
 274        $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
 275
 276$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
 277        $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
 278        $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
 279        mv $@+ $@
 280
 281howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
 282        $(QUIET_GEN)$(RM) $@+ $@ && \
 283        sh ./howto-index.sh $(wildcard howto/*.txt) >$@+ && \
 284        mv $@+ $@
 285
 286$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
 287        $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 $*.txt
 288
 289WEBDOC_DEST = /pub/software/scm/git/docs
 290
 291$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
 292        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 293        sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b xhtml11 - >$@+ && \
 294        mv $@+ $@
 295
 296install-webdoc : html
 297        sh ./install-webdoc.sh $(WEBDOC_DEST)
 298
 299quick-install: quick-install-man
 300
 301quick-install-man:
 302        sh ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)
 303
 304quick-install-html:
 305        sh ./install-doc-quick.sh $(HTML_REF) $(DESTDIR)$(htmldir)
 306
 307.PHONY: .FORCE-GIT-VERSION-FILE