Andrew's git - gitweb.git/blob

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