Andrew's git - gitweb.git/blob - Documentation/Makefile

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