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 gitweb.txt git.txt
   5MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt \
   6        gitrepository-layout.txt gitweb.conf.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
  10MAN7_TXT += gitcredentials.txt
  11
  12MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
  13MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
  14MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
  15
  16DOC_HTML=$(MAN_HTML)
  17
  18ARTICLES = howto-index
  19ARTICLES += everyday
  20ARTICLES += git-tools
  21ARTICLES += git-bisect-lk2009
  22# with their own formatting rules.
  23SP_ARTICLES = user-manual
  24SP_ARTICLES += howto/revert-branch-rebase
  25SP_ARTICLES += howto/using-merge-subtree
  26SP_ARTICLES += howto/using-signed-tag-in-pull-request
  27API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
  28SP_ARTICLES += $(API_DOCS)
  29SP_ARTICLES += technical/api-index
  30
  31DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
  32
  33DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
  34DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT))
  35DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
  36
  37prefix?=$(HOME)
  38bindir?=$(prefix)/bin
  39htmldir?=$(prefix)/share/doc/git-doc
  40pdfdir?=$(prefix)/share/doc/git-doc
  41mandir?=$(prefix)/share/man
  42man1dir=$(mandir)/man1
  43man5dir=$(mandir)/man5
  44man7dir=$(mandir)/man7
  45# DESTDIR=
  46
  47ASCIIDOC=asciidoc
  48ASCIIDOC_EXTRA =
  49MANPAGE_XSL = manpage-normal.xsl
  50XMLTO_EXTRA =
  51INSTALL?=install
  52RM ?= rm -f
  53MAN_REPO = ../../git-manpages
  54HTML_REPO = ../../git-htmldocs
  55
  56infodir?=$(prefix)/share/info
  57MAKEINFO=makeinfo
  58INSTALL_INFO=install-info
  59DOCBOOK2X_TEXI=docbook2x-texi
  60DBLATEX=dblatex
  61ifndef PERL_PATH
  62        PERL_PATH = /usr/bin/perl
  63endif
  64
  65-include ../config.mak.autogen
  66-include ../config.mak
  67
  68#
  69# For docbook-xsl ...
  70#       -1.68.1,        no extra settings are needed?
  71#       1.69.0,         set ASCIIDOC_ROFF?
  72#       1.69.1-1.71.0,  set DOCBOOK_SUPPRESS_SP?
  73#       1.71.1,         set ASCIIDOC_ROFF?
  74#       1.72.0,         set DOCBOOK_XSL_172.
  75#       1.73.0-,        no extra settings are needed
  76#
  77
  78ifdef DOCBOOK_XSL_172
  79ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
  80MANPAGE_XSL = manpage-1.72.xsl
  81else
  82        ifndef ASCIIDOC_ROFF
  83        # docbook-xsl after 1.72 needs the regular XSL, but will not
  84        # pass-thru raw roff codes from asciidoc.conf, so turn them off.
  85        ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
  86        endif
  87endif
  88ifdef MAN_BOLD_LITERAL
  89XMLTO_EXTRA += -m manpage-bold-literal.xsl
  90endif
  91ifdef DOCBOOK_SUPPRESS_SP
  92XMLTO_EXTRA += -m manpage-suppress-sp.xsl
  93endif
  94
  95# Newer DocBook stylesheet emits warning cruft in the output when
  96# this is not set, and if set it shows an absolute link.  Older
  97# stylesheets simply ignore this parameter.
  98#
  99# Distros may want to use MAN_BASE_URL=file:///path/to/git/docs/
 100# or similar.
 101ifndef MAN_BASE_URL
 102MAN_BASE_URL = file://$(htmldir)/
 103endif
 104XMLTO_EXTRA += -m manpage-base-url.xsl
 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
 118ifdef DEFAULT_PAGER
 119DEFAULT_PAGER_SQ = $(subst ','\'',$(DEFAULT_PAGER))
 120ASCIIDOC_EXTRA += -a 'git-default-pager=$(DEFAULT_PAGER_SQ)'
 121endif
 122
 123ifdef DEFAULT_EDITOR
 124DEFAULT_EDITOR_SQ = $(subst ','\'',$(DEFAULT_EDITOR))
 125ASCIIDOC_EXTRA += -a 'git-default-editor=$(DEFAULT_EDITOR_SQ)'
 126endif
 127
 128QUIET_SUBDIR0  = +$(MAKE) -C # space to separate -C and subdir
 129QUIET_SUBDIR1  =
 130
 131ifneq ($(findstring $(MAKEFLAGS),w),w)
 132PRINT_DIR = --no-print-directory
 133else # "make -w"
 134NO_SUBDIR = :
 135endif
 136
 137ifneq ($(findstring $(MAKEFLAGS),s),s)
 138ifndef V
 139        QUIET_ASCIIDOC  = @echo '   ' ASCIIDOC $@;
 140        QUIET_XMLTO     = @echo '   ' XMLTO $@;
 141        QUIET_DB2TEXI   = @echo '   ' DB2TEXI $@;
 142        QUIET_MAKEINFO  = @echo '   ' MAKEINFO $@;
 143        QUIET_DBLATEX   = @echo '   ' DBLATEX $@;
 144        QUIET_XSLTPROC  = @echo '   ' XSLTPROC $@;
 145        QUIET_GEN       = @echo '   ' GEN $@;
 146        QUIET_STDERR    = 2> /dev/null
 147        QUIET_SUBDIR0   = +@subdir=
 148        QUIET_SUBDIR1   = ;$(NO_SUBDIR) echo '   ' SUBDIR $$subdir; \
 149                          $(MAKE) $(PRINT_DIR) -C $$subdir
 150        export V
 151endif
 152endif
 153
 154all: html man
 155
 156html: $(DOC_HTML)
 157
 158$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
 159
 160man: man1 man5 man7
 161man1: $(DOC_MAN1)
 162man5: $(DOC_MAN5)
 163man7: $(DOC_MAN7)
 164
 165info: git.info gitman.info
 166
 167pdf: user-manual.pdf
 168
 169install: install-man
 170
 171install-man: man
 172        $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
 173        $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
 174        $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
 175        $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
 176        $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
 177        $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
 178
 179install-info: info
 180        $(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
 181        $(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
 182        if test -r $(DESTDIR)$(infodir)/dir; then \
 183          $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
 184          $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
 185        else \
 186          echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
 187        fi
 188
 189install-pdf: pdf
 190        $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
 191        $(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)
 192
 193install-html: html
 194        '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
 195
 196../GIT-VERSION-FILE: FORCE
 197        $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
 198
 199-include ../GIT-VERSION-FILE
 200
 201#
 202# Determine "include::" file references in asciidoc files.
 203#
 204doc.dep : $(wildcard *.txt) build-docdep.perl
 205        $(QUIET_GEN)$(RM) $@+ $@ && \
 206        $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
 207        mv $@+ $@
 208
 209-include doc.dep
 210
 211cmds_txt = cmds-ancillaryinterrogators.txt \
 212        cmds-ancillarymanipulators.txt \
 213        cmds-mainporcelain.txt \
 214        cmds-plumbinginterrogators.txt \
 215        cmds-plumbingmanipulators.txt \
 216        cmds-synchingrepositories.txt \
 217        cmds-synchelpers.txt \
 218        cmds-purehelpers.txt \
 219        cmds-foreignscminterface.txt
 220
 221$(cmds_txt): cmd-list.made
 222
 223cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
 224        $(QUIET_GEN)$(RM) $@ && \
 225        $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
 226        date >$@
 227
 228clean:
 229        $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
 230        $(RM) *.texi *.texi+ *.texi++ git.info gitman.info
 231        $(RM) *.pdf
 232        $(RM) howto-index.txt howto/*.html doc.dep
 233        $(RM) technical/api-*.html technical/api-index.txt
 234        $(RM) $(cmds_txt) *.made
 235        $(RM) manpage-base-url.xsl
 236
 237$(MAN_HTML): %.html : %.txt
 238        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 239        $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
 240                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
 241        mv $@+ $@
 242
 243manpage-base-url.xsl: manpage-base-url.xsl.in
 244        sed "s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|" $< > $@
 245
 246%.1 %.5 %.7 : %.xml manpage-base-url.xsl
 247        $(QUIET_XMLTO)$(RM) $@ && \
 248        xmlto -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
 249
 250%.xml : %.txt
 251        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 252        $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
 253                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
 254        mv $@+ $@
 255
 256user-manual.xml: user-manual.txt user-manual.conf
 257        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 258        $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d book -o $@+ $< && \
 259        mv $@+ $@
 260
 261technical/api-index.txt: technical/api-index-skel.txt \
 262        technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
 263        $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh
 264
 265technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
 266$(patsubst %,%.html,$(API_DOCS) technical/api-index): %.html : %.txt
 267        $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
 268                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
 269
 270XSLT = docbook.xsl
 271XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
 272
 273user-manual.html: user-manual.xml $(XSLT)
 274        $(QUIET_XSLTPROC)$(RM) $@+ $@ && \
 275        xsltproc $(XSLTOPTS) -o $@+ $(XSLT) $< && \
 276        mv $@+ $@
 277
 278git.info: user-manual.texi
 279        $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
 280
 281user-manual.texi: user-manual.xml
 282        $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
 283        $(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
 284        $(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
 285        rm $@++ && \
 286        mv $@+ $@
 287
 288user-manual.pdf: user-manual.xml
 289        $(QUIET_DBLATEX)$(RM) $@+ $@ && \
 290        $(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $< && \
 291        mv $@+ $@
 292
 293gitman.texi: $(MAN_XML) cat-texi.perl
 294        $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
 295        ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
 296                --to-stdout $(xml) &&) true) > $@++ && \
 297        $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
 298        rm $@++ && \
 299        mv $@+ $@
 300
 301gitman.info: gitman.texi
 302        $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
 303
 304$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
 305        $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
 306        $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
 307        mv $@+ $@
 308
 309howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
 310        $(QUIET_GEN)$(RM) $@+ $@ && \
 311        '$(SHELL_PATH_SQ)' ./howto-index.sh $(wildcard howto/*.txt) >$@+ && \
 312        mv $@+ $@
 313
 314$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
 315        $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 $*.txt
 316
 317WEBDOC_DEST = /pub/software/scm/git/docs
 318
 319howto/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
 320$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
 321        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 322        sed -e '1,/^$$/d' $< | $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 - >$@+ && \
 323        mv $@+ $@
 324
 325install-webdoc : html
 326        '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
 327
 328# You must have a clone of git-htmldocs and git-manpages repositories
 329# next to the git repository itself for the following to work.
 330
 331quick-install: quick-install-man
 332
 333require-manrepo::
 334        @if test ! -d $(MAN_REPO); \
 335        then echo "git-manpages repository must exist at $(MAN_REPO)"; exit 1; fi
 336
 337quick-install-man: require-manrepo
 338        '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(MAN_REPO) $(DESTDIR)$(mandir)
 339
 340require-htmlrepo::
 341        @if test ! -d $(HTML_REPO); \
 342        then echo "git-htmldocs repository must exist at $(HTML_REPO)"; exit 1; fi
 343
 344quick-install-html: require-htmlrepo
 345        '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REPO) $(DESTDIR)$(htmldir)
 346
 347print-man1:
 348        @for i in $(MAN1_TXT); do echo $$i; done
 349
 350.PHONY: FORCE