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