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
  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
 106# Newer DocBook stylesheet emits warning cruft in the output when
 107# this is not set, and if set it shows an absolute link.  We can
 108# use MAN_BASE_URL=http://www.kernel.org/pub/software/scm/git/docs/
 109# but distros may want to set it to /usr/share/doc/git-core/docs/ or
 110# something like that.
 111#
 112# As older stylesheets simply ignore this parameter, it ought to be
 113# safe to set it to empty string when the base URL is not specified,
 114# but unfortunately we cannot do so unconditionally because at least
 115# xmlto 0.0.18 is reported to lack --stringparam option.
 116ifdef MAN_BASE_URL
 117XMLTO_EXTRA += --stringparam man.base.url.for.relative.links=$(MAN_BASE_URL)
 118endif
 119
 120# If your target system uses GNU groff, it may try to render
 121# apostrophes as a "pretty" apostrophe using unicode.  This breaks
 122# cut&paste, so you should set GNU_ROFF to force them to be ASCII
 123# apostrophes.  Unfortunately does not work with non-GNU roff.
 124ifdef GNU_ROFF
 125XMLTO_EXTRA += -m manpage-quote-apos.xsl
 126endif
 127
 128SHELL_PATH ?= $(SHELL)
 129# Shell quote;
 130SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
 131
 132#
 133# Please note that there is a minor bug in asciidoc.
 134# The version after 6.0.3 _will_ include the patch found here:
 135#   http://marc.theaimsgroup.com/?l=git&m=111558757202243&w=2
 136#
 137# Until that version is released you may have to apply the patch
 138# yourself - yes, all 6 characters of it!
 139#
 140
 141QUIET_SUBDIR0  = +$(MAKE) -C # space to separate -C and subdir
 142QUIET_SUBDIR1  =
 143
 144ifneq ($(findstring $(MAKEFLAGS),w),w)
 145PRINT_DIR = --no-print-directory
 146else # "make -w"
 147NO_SUBDIR = :
 148endif
 149
 150ifneq ($(findstring $(MAKEFLAGS),s),s)
 151ifndef V
 152        QUIET_ASCIIDOC  = @echo '   ' ASCIIDOC $@;
 153        QUIET_XMLTO     = @echo '   ' XMLTO $@;
 154        QUIET_DB2TEXI   = @echo '   ' DB2TEXI $@;
 155        QUIET_MAKEINFO  = @echo '   ' MAKEINFO $@;
 156        QUIET_DBLATEX   = @echo '   ' DBLATEX $@;
 157        QUIET_XSLTPROC  = @echo '   ' XSLTPROC $@;
 158        QUIET_GEN       = @echo '   ' GEN $@;
 159        QUIET_STDERR    = 2> /dev/null
 160        QUIET_SUBDIR0   = +@subdir=
 161        QUIET_SUBDIR1   = ;$(NO_SUBDIR) echo '   ' SUBDIR $$subdir; \
 162                          $(MAKE) $(PRINT_DIR) -C $$subdir
 163        export V
 164endif
 165endif
 166
 167all: html man
 168
 169html: $(DOC_HTML)
 170
 171$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
 172
 173man: man1 man5 man7
 174man1: $(DOC_MAN1)
 175man5: $(DOC_MAN5)
 176man7: $(DOC_MAN7)
 177
 178info: git.info gitman.info
 179
 180pdf: user-manual.pdf
 181
 182install: install-man
 183
 184install-man: man
 185        $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
 186        $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
 187        $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
 188        $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
 189        $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
 190        $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
 191
 192install-info: info
 193        $(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
 194        $(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
 195        if test -r $(DESTDIR)$(infodir)/dir; then \
 196          $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
 197          $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
 198        else \
 199          echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
 200        fi
 201
 202install-pdf: pdf
 203        $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
 204        $(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)
 205
 206install-html: html
 207        '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
 208
 209../GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
 210        $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
 211
 212-include ../GIT-VERSION-FILE
 213
 214#
 215# Determine "include::" file references in asciidoc files.
 216#
 217doc.dep : $(wildcard *.txt) build-docdep.perl
 218        $(QUIET_GEN)$(RM) $@+ $@ && \
 219        $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
 220        mv $@+ $@
 221
 222-include doc.dep
 223
 224cmds_txt = cmds-ancillaryinterrogators.txt \
 225        cmds-ancillarymanipulators.txt \
 226        cmds-mainporcelain.txt \
 227        cmds-plumbinginterrogators.txt \
 228        cmds-plumbingmanipulators.txt \
 229        cmds-synchingrepositories.txt \
 230        cmds-synchelpers.txt \
 231        cmds-purehelpers.txt \
 232        cmds-foreignscminterface.txt
 233
 234$(cmds_txt): cmd-list.made
 235
 236cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
 237        $(QUIET_GEN)$(RM) $@ && \
 238        $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
 239        date >$@
 240
 241clean:
 242        $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
 243        $(RM) *.texi *.texi+ *.texi++ git.info gitman.info
 244        $(RM) howto-index.txt howto/*.html doc.dep
 245        $(RM) technical/api-*.html technical/api-index.txt
 246        $(RM) $(cmds_txt) *.made
 247
 248$(MAN_HTML): %.html : %.txt
 249        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 250        $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
 251                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
 252        mv $@+ $@
 253
 254%.1 %.5 %.7 : %.xml
 255        $(QUIET_XMLTO)$(RM) $@ && \
 256        xmlto -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
 257
 258%.xml : %.txt
 259        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 260        $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
 261                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
 262        mv $@+ $@
 263
 264user-manual.xml: user-manual.txt user-manual.conf
 265        $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d book $<
 266
 267technical/api-index.txt: technical/api-index-skel.txt \
 268        technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
 269        $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh
 270
 271$(patsubst %,%.html,$(API_DOCS) technical/api-index): %.html : %.txt
 272        $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
 273                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
 274
 275XSLT = docbook.xsl
 276XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
 277
 278user-manual.html: user-manual.xml
 279        $(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
 280
 281git.info: user-manual.texi
 282        $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
 283
 284user-manual.texi: user-manual.xml
 285        $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
 286        $(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
 287        $(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
 288        rm $@++ && \
 289        mv $@+ $@
 290
 291user-manual.pdf: user-manual.xml
 292        $(QUIET_DBLATEX)$(RM) $@+ $@ && \
 293        $(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $< && \
 294        mv $@+ $@
 295
 296gitman.texi: $(MAN_XML) cat-texi.perl
 297        $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
 298        ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
 299                --to-stdout $(xml) &&) true) > $@++ && \
 300        $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
 301        rm $@++ && \
 302        mv $@+ $@
 303
 304gitman.info: gitman.texi
 305        $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
 306
 307$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
 308        $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
 309        $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
 310        mv $@+ $@
 311
 312howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
 313        $(QUIET_GEN)$(RM) $@+ $@ && \
 314        '$(SHELL_PATH_SQ)' ./howto-index.sh $(wildcard howto/*.txt) >$@+ && \
 315        mv $@+ $@
 316
 317$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
 318        $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 $*.txt
 319
 320WEBDOC_DEST = /pub/software/scm/git/docs
 321
 322$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
 323        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 324        sed -e '1,/^$$/d' $< | $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 - >$@+ && \
 325        mv $@+ $@
 326
 327install-webdoc : html
 328        '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
 329
 330quick-install: quick-install-man
 331
 332quick-install-man:
 333        '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)
 334
 335quick-install-html:
 336        '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REF) $(DESTDIR)$(htmldir)
 337
 338.PHONY: .FORCE-GIT-VERSION-FILE