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 gitnamespaces.txt gitrevisions.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
  49MAN_REPO = ../../git-manpages
  50HTML_REPO = ../../git-htmldocs
  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, set ASCIIDOC7
  67#       8.0-,   no extra settings are needed
  68#
  69
  70#
  71# For docbook-xsl ...
  72#       -1.68.1,        no extra settings are needed?
  73#       1.69.0,         set ASCIIDOC_ROFF?
  74#       1.69.1-1.71.0,  set DOCBOOK_SUPPRESS_SP?
  75#       1.71.1,         set ASCIIDOC_ROFF?
  76#       1.72.0,         set DOCBOOK_XSL_172.
  77#       1.73.0-,        no extra settings are needed
  78#
  79
  80ifndef ASCIIDOC7
  81ASCIIDOC_EXTRA += -a asciidoc7compatible -a no-inline-literal
  82endif
  83ifdef DOCBOOK_XSL_172
  84ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
  85MANPAGE_XSL = manpage-1.72.xsl
  86else
  87        ifndef ASCIIDOC_ROFF
  88        # docbook-xsl after 1.72 needs the regular XSL, but will not
  89        # pass-thru raw roff codes from asciidoc.conf, so turn them off.
  90        ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
  91        endif
  92endif
  93ifdef MAN_BOLD_LITERAL
  94XMLTO_EXTRA += -m manpage-bold-literal.xsl
  95endif
  96ifdef DOCBOOK_SUPPRESS_SP
  97XMLTO_EXTRA += -m manpage-suppress-sp.xsl
  98endif
  99
 100# Newer DocBook stylesheet emits warning cruft in the output when
 101# this is not set, and if set it shows an absolute link.  Older
 102# stylesheets simply ignore this parameter.
 103#
 104# Distros may want to use MAN_BASE_URL=file:///path/to/git/docs/
 105# or similar.
 106ifndef MAN_BASE_URL
 107MAN_BASE_URL = file://$(htmldir)/
 108endif
 109XMLTO_EXTRA += -m manpage-base-url.xsl
 110
 111# If your target system uses GNU groff, it may try to render
 112# apostrophes as a "pretty" apostrophe using unicode.  This breaks
 113# cut&paste, so you should set GNU_ROFF to force them to be ASCII
 114# apostrophes.  Unfortunately does not work with non-GNU roff.
 115ifdef GNU_ROFF
 116XMLTO_EXTRA += -m manpage-quote-apos.xsl
 117endif
 118
 119SHELL_PATH ?= $(SHELL)
 120# Shell quote;
 121SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
 122
 123#
 124# Please note that there is a minor bug in asciidoc.
 125# The version after 6.0.3 _will_ include the patch found here:
 126#   http://marc.theaimsgroup.com/?l=git&m=111558757202243&w=2
 127#
 128# Until that version is released you may have to apply the patch
 129# yourself - yes, all 6 characters of it!
 130#
 131
 132QUIET_SUBDIR0  = +$(MAKE) -C # space to separate -C and subdir
 133QUIET_SUBDIR1  =
 134
 135ifneq ($(findstring $(MAKEFLAGS),w),w)
 136PRINT_DIR = --no-print-directory
 137else # "make -w"
 138NO_SUBDIR = :
 139endif
 140
 141ifneq ($(findstring $(MAKEFLAGS),s),s)
 142ifndef V
 143        QUIET_ASCIIDOC  = @echo '   ' ASCIIDOC $@;
 144        QUIET_XMLTO     = @echo '   ' XMLTO $@;
 145        QUIET_DB2TEXI   = @echo '   ' DB2TEXI $@;
 146        QUIET_MAKEINFO  = @echo '   ' MAKEINFO $@;
 147        QUIET_DBLATEX   = @echo '   ' DBLATEX $@;
 148        QUIET_XSLTPROC  = @echo '   ' XSLTPROC $@;
 149        QUIET_GEN       = @echo '   ' GEN $@;
 150        QUIET_STDERR    = 2> /dev/null
 151        QUIET_SUBDIR0   = +@subdir=
 152        QUIET_SUBDIR1   = ;$(NO_SUBDIR) echo '   ' SUBDIR $$subdir; \
 153                          $(MAKE) $(PRINT_DIR) -C $$subdir
 154        export V
 155endif
 156endif
 157
 158all: html man
 159
 160html: $(DOC_HTML)
 161
 162$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
 163
 164man: man1 man5 man7
 165man1: $(DOC_MAN1)
 166man5: $(DOC_MAN5)
 167man7: $(DOC_MAN7)
 168
 169info: git.info gitman.info
 170
 171pdf: user-manual.pdf
 172
 173install: install-man
 174
 175install-man: man
 176        $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
 177        $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
 178        $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
 179        $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
 180        $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
 181        $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
 182
 183install-info: info
 184        $(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
 185        $(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
 186        if test -r $(DESTDIR)$(infodir)/dir; then \
 187          $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
 188          $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
 189        else \
 190          echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
 191        fi
 192
 193install-pdf: pdf
 194        $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
 195        $(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)
 196
 197install-html: html
 198        '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
 199
 200../GIT-VERSION-FILE: FORCE
 201        $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
 202
 203-include ../GIT-VERSION-FILE
 204
 205#
 206# Determine "include::" file references in asciidoc files.
 207#
 208doc.dep : $(wildcard *.txt) build-docdep.perl
 209        $(QUIET_GEN)$(RM) $@+ $@ && \
 210        $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
 211        mv $@+ $@
 212
 213-include doc.dep
 214
 215cmds_txt = cmds-ancillaryinterrogators.txt \
 216        cmds-ancillarymanipulators.txt \
 217        cmds-mainporcelain.txt \
 218        cmds-plumbinginterrogators.txt \
 219        cmds-plumbingmanipulators.txt \
 220        cmds-synchingrepositories.txt \
 221        cmds-synchelpers.txt \
 222        cmds-purehelpers.txt \
 223        cmds-foreignscminterface.txt
 224
 225$(cmds_txt): cmd-list.made
 226
 227cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
 228        $(QUIET_GEN)$(RM) $@ && \
 229        $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
 230        date >$@
 231
 232clean:
 233        $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
 234        $(RM) *.texi *.texi+ *.texi++ git.info gitman.info
 235        $(RM) *.pdf
 236        $(RM) howto-index.txt howto/*.html doc.dep
 237        $(RM) technical/api-*.html technical/api-index.txt
 238        $(RM) $(cmds_txt) *.made
 239        $(RM) manpage-base-url.xsl
 240
 241$(MAN_HTML): %.html : %.txt
 242        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 243        $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
 244                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
 245        mv $@+ $@
 246
 247manpage-base-url.xsl: manpage-base-url.xsl.in
 248        sed "s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|" $< > $@
 249
 250%.1 %.5 %.7 : %.xml manpage-base-url.xsl
 251        $(QUIET_XMLTO)$(RM) $@ && \
 252        xmlto -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
 253
 254%.xml : %.txt
 255        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 256        $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
 257                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
 258        mv $@+ $@
 259
 260user-manual.xml: user-manual.txt user-manual.conf
 261        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 262        $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d book -o $@+ $< && \
 263        mv $@+ $@
 264
 265technical/api-index.txt: technical/api-index-skel.txt \
 266        technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
 267        $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh
 268
 269$(patsubst %,%.html,$(API_DOCS) technical/api-index): %.html : %.txt
 270        $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
 271                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
 272
 273XSLT = docbook.xsl
 274XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
 275
 276user-manual.html: user-manual.xml $(XSLT)
 277        $(QUIET_XSLTPROC)$(RM) $@+ $@ && \
 278        xsltproc $(XSLTOPTS) -o $@+ $(XSLT) $< && \
 279        mv $@+ $@
 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
 330# You must have a clone of git-htmldocs and git-manpages repositories
 331# next to the git repository itself for the following to work.
 332
 333quick-install: quick-install-man
 334
 335require-manrepo::
 336        @if test ! -d $(MAN_REPO); \
 337        then echo "git-manpages repository must exist at $(MAN_REPO)"; exit 1; fi
 338
 339quick-install-man: require-manrepo
 340        '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(MAN_REPO) $(DESTDIR)$(mandir)
 341
 342require-htmlrepo::
 343        @if test ! -d $(HTML_REPO); \
 344        then echo "git-htmldocs repository must exist at $(HTML_REPO)"; exit 1; fi
 345
 346quick-install-html: require-htmlrepo
 347        '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REPO) $(DESTDIR)$(htmldir)
 348
 349.PHONY: FORCE