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

   1# Guard against environment variables
   2MAN1_TXT =
   3MAN5_TXT =
   4MAN7_TXT =
   5
   6MAN1_TXT += $(filter-out \
   7                $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
   8                $(wildcard git-*.txt))
   9MAN1_TXT += git.txt
  10MAN1_TXT += gitk.txt
  11MAN1_TXT += gitremote-helpers.txt
  12MAN1_TXT += gitweb.txt
  13
  14MAN5_TXT += gitattributes.txt
  15MAN5_TXT += githooks.txt
  16MAN5_TXT += gitignore.txt
  17MAN5_TXT += gitmodules.txt
  18MAN5_TXT += gitrepository-layout.txt
  19MAN5_TXT += gitweb.conf.txt
  20
  21MAN7_TXT += gitcli.txt
  22MAN7_TXT += gitcore-tutorial.txt
  23MAN7_TXT += gitcredentials.txt
  24MAN7_TXT += gitcvs-migration.txt
  25MAN7_TXT += gitdiffcore.txt
  26MAN7_TXT += gitglossary.txt
  27MAN7_TXT += gitnamespaces.txt
  28MAN7_TXT += gitrevisions.txt
  29MAN7_TXT += gittutorial-2.txt
  30MAN7_TXT += gittutorial.txt
  31MAN7_TXT += gitworkflows.txt
  32
  33MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
  34MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
  35MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT))
  36
  37OBSOLETE_HTML = git-remote-helpers.html
  38DOC_HTML = $(MAN_HTML) $(OBSOLETE_HTML)
  39
  40ARTICLES = howto-index
  41ARTICLES += everyday
  42ARTICLES += git-tools
  43ARTICLES += git-bisect-lk2009
  44# with their own formatting rules.
  45SP_ARTICLES = user-manual
  46SP_ARTICLES += howto/new-command
  47SP_ARTICLES += howto/revert-branch-rebase
  48SP_ARTICLES += howto/using-merge-subtree
  49SP_ARTICLES += howto/using-signed-tag-in-pull-request
  50SP_ARTICLES += howto/use-git-daemon
  51SP_ARTICLES += howto/update-hook-example
  52SP_ARTICLES += howto/setup-git-server-over-http
  53SP_ARTICLES += howto/separating-topic-branches
  54SP_ARTICLES += howto/revert-a-faulty-merge
  55SP_ARTICLES += howto/recover-corrupted-blob-object
  56SP_ARTICLES += howto/recover-corrupted-object-harder
  57SP_ARTICLES += howto/rebuild-from-update-hook
  58SP_ARTICLES += howto/rebase-from-internal-branch
  59SP_ARTICLES += howto/maintain-git
  60API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
  61SP_ARTICLES += $(API_DOCS)
  62
  63TECH_DOCS = technical/http-protocol
  64TECH_DOCS += technical/index-format
  65TECH_DOCS += technical/pack-format
  66TECH_DOCS += technical/pack-heuristics
  67TECH_DOCS += technical/pack-protocol
  68TECH_DOCS += technical/protocol-capabilities
  69TECH_DOCS += technical/protocol-common
  70TECH_DOCS += technical/racy-git
  71TECH_DOCS += technical/send-pack-pipeline
  72TECH_DOCS += technical/shallow
  73TECH_DOCS += technical/trivial-merge
  74SP_ARTICLES += $(TECH_DOCS)
  75SP_ARTICLES += technical/api-index
  76
  77DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
  78
  79DOC_MAN1 = $(patsubst %.txt,%.1,$(MAN1_TXT))
  80DOC_MAN5 = $(patsubst %.txt,%.5,$(MAN5_TXT))
  81DOC_MAN7 = $(patsubst %.txt,%.7,$(MAN7_TXT))
  82
  83prefix ?= $(HOME)
  84bindir ?= $(prefix)/bin
  85htmldir ?= $(prefix)/share/doc/git-doc
  86infodir ?= $(prefix)/share/info
  87pdfdir ?= $(prefix)/share/doc/git-doc
  88mandir ?= $(prefix)/share/man
  89man1dir = $(mandir)/man1
  90man5dir = $(mandir)/man5
  91man7dir = $(mandir)/man7
  92# DESTDIR =
  93
  94ASCIIDOC = asciidoc
  95ASCIIDOC_EXTRA =
  96MANPAGE_XSL = manpage-normal.xsl
  97XMLTO = xmlto
  98XMLTO_EXTRA =
  99INSTALL ?= install
 100RM ?= rm -f
 101MAN_REPO = ../../git-manpages
 102HTML_REPO = ../../git-htmldocs
 103
 104MAKEINFO = makeinfo
 105INSTALL_INFO = install-info
 106DOCBOOK2X_TEXI = docbook2x-texi
 107DBLATEX = dblatex
 108ASCIIDOC_DBLATEX_DIR = /etc/asciidoc/dblatex
 109ifndef PERL_PATH
 110        PERL_PATH = /usr/bin/perl
 111endif
 112
 113-include ../config.mak.autogen
 114-include ../config.mak
 115
 116#
 117# For docbook-xsl ...
 118#       -1.68.1,        no extra settings are needed?
 119#       1.69.0,         set ASCIIDOC_ROFF?
 120#       1.69.1-1.71.0,  set DOCBOOK_SUPPRESS_SP?
 121#       1.71.1,         set ASCIIDOC_ROFF?
 122#       1.72.0,         set DOCBOOK_XSL_172.
 123#       1.73.0-,        no extra settings are needed
 124#
 125
 126ifdef DOCBOOK_XSL_172
 127ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
 128MANPAGE_XSL = manpage-1.72.xsl
 129else
 130        ifndef ASCIIDOC_ROFF
 131        # docbook-xsl after 1.72 needs the regular XSL, but will not
 132        # pass-thru raw roff codes from asciidoc.conf, so turn them off.
 133        ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
 134        endif
 135endif
 136ifdef MAN_BOLD_LITERAL
 137XMLTO_EXTRA += -m manpage-bold-literal.xsl
 138endif
 139ifdef DOCBOOK_SUPPRESS_SP
 140XMLTO_EXTRA += -m manpage-suppress-sp.xsl
 141endif
 142
 143# Newer DocBook stylesheet emits warning cruft in the output when
 144# this is not set, and if set it shows an absolute link.  Older
 145# stylesheets simply ignore this parameter.
 146#
 147# Distros may want to use MAN_BASE_URL=file:///path/to/git/docs/
 148# or similar.
 149ifndef MAN_BASE_URL
 150MAN_BASE_URL = file://$(htmldir)/
 151endif
 152XMLTO_EXTRA += -m manpage-base-url.xsl
 153
 154# If your target system uses GNU groff, it may try to render
 155# apostrophes as a "pretty" apostrophe using unicode.  This breaks
 156# cut&paste, so you should set GNU_ROFF to force them to be ASCII
 157# apostrophes.  Unfortunately does not work with non-GNU roff.
 158ifdef GNU_ROFF
 159XMLTO_EXTRA += -m manpage-quote-apos.xsl
 160endif
 161
 162SHELL_PATH ?= $(SHELL)
 163# Shell quote;
 164SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
 165
 166ifdef DEFAULT_PAGER
 167DEFAULT_PAGER_SQ = $(subst ','\'',$(DEFAULT_PAGER))
 168ASCIIDOC_EXTRA += -a 'git-default-pager=$(DEFAULT_PAGER_SQ)'
 169endif
 170
 171ifdef DEFAULT_EDITOR
 172DEFAULT_EDITOR_SQ = $(subst ','\'',$(DEFAULT_EDITOR))
 173ASCIIDOC_EXTRA += -a 'git-default-editor=$(DEFAULT_EDITOR_SQ)'
 174endif
 175
 176QUIET_SUBDIR0  = +$(MAKE) -C # space to separate -C and subdir
 177QUIET_SUBDIR1  =
 178
 179ifneq ($(findstring $(MAKEFLAGS),w),w)
 180PRINT_DIR = --no-print-directory
 181else # "make -w"
 182NO_SUBDIR = :
 183endif
 184
 185ifneq ($(findstring $(MAKEFLAGS),s),s)
 186ifndef V
 187        QUIET_ASCIIDOC  = @echo '   ' ASCIIDOC $@;
 188        QUIET_XMLTO     = @echo '   ' XMLTO $@;
 189        QUIET_DB2TEXI   = @echo '   ' DB2TEXI $@;
 190        QUIET_MAKEINFO  = @echo '   ' MAKEINFO $@;
 191        QUIET_DBLATEX   = @echo '   ' DBLATEX $@;
 192        QUIET_XSLTPROC  = @echo '   ' XSLTPROC $@;
 193        QUIET_GEN       = @echo '   ' GEN $@;
 194        QUIET_STDERR    = 2> /dev/null
 195        QUIET_SUBDIR0   = +@subdir=
 196        QUIET_SUBDIR1   = ;$(NO_SUBDIR) echo '   ' SUBDIR $$subdir; \
 197                          $(MAKE) $(PRINT_DIR) -C $$subdir
 198        export V
 199endif
 200endif
 201
 202all: html man
 203
 204html: $(DOC_HTML)
 205
 206man: man1 man5 man7
 207man1: $(DOC_MAN1)
 208man5: $(DOC_MAN5)
 209man7: $(DOC_MAN7)
 210
 211info: git.info gitman.info
 212
 213pdf: user-manual.pdf
 214
 215install: install-man
 216
 217install-man: man
 218        $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
 219        $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
 220        $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
 221        $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
 222        $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
 223        $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
 224
 225install-info: info
 226        $(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
 227        $(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
 228        if test -r $(DESTDIR)$(infodir)/dir; then \
 229          $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
 230          $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
 231        else \
 232          echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
 233        fi
 234
 235install-pdf: pdf
 236        $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
 237        $(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)
 238
 239install-html: html
 240        '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
 241
 242../GIT-VERSION-FILE: FORCE
 243        $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
 244
 245-include ../GIT-VERSION-FILE
 246
 247#
 248# Determine "include::" file references in asciidoc files.
 249#
 250docdep_prereqs = \
 251        mergetools-list.made $(mergetools_txt) \
 252        cmd-list.made $(cmds_txt)
 253
 254doc.dep : $(docdep_prereqs) $(wildcard *.txt) build-docdep.perl
 255        $(QUIET_GEN)$(RM) $@+ $@ && \
 256        $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
 257        mv $@+ $@
 258
 259-include doc.dep
 260
 261cmds_txt = cmds-ancillaryinterrogators.txt \
 262        cmds-ancillarymanipulators.txt \
 263        cmds-mainporcelain.txt \
 264        cmds-plumbinginterrogators.txt \
 265        cmds-plumbingmanipulators.txt \
 266        cmds-synchingrepositories.txt \
 267        cmds-synchelpers.txt \
 268        cmds-purehelpers.txt \
 269        cmds-foreignscminterface.txt
 270
 271$(cmds_txt): cmd-list.made
 272
 273cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
 274        $(QUIET_GEN)$(RM) $@ && \
 275        $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
 276        date >$@
 277
 278mergetools_txt = mergetools-diff.txt mergetools-merge.txt
 279
 280$(mergetools_txt): mergetools-list.made
 281
 282mergetools-list.made: ../git-mergetool--lib.sh $(wildcard ../mergetools/*)
 283        $(QUIET_GEN)$(RM) $@ && \
 284        $(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
 285                . ../git-mergetool--lib.sh && \
 286                show_tool_names can_diff "* " || :' >mergetools-diff.txt && \
 287        $(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
 288                . ../git-mergetool--lib.sh && \
 289                show_tool_names can_merge "* " || :' >mergetools-merge.txt && \
 290        date >$@
 291
 292clean:
 293        $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
 294        $(RM) *.texi *.texi+ *.texi++ git.info gitman.info
 295        $(RM) *.pdf
 296        $(RM) howto-index.txt howto/*.html doc.dep
 297        $(RM) technical/*.html technical/api-index.txt
 298        $(RM) $(cmds_txt) $(mergetools_txt) *.made
 299        $(RM) manpage-base-url.xsl
 300
 301$(MAN_HTML): %.html : %.txt asciidoc.conf
 302        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 303        $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
 304                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
 305        mv $@+ $@
 306
 307$(OBSOLETE_HTML): %.html : %.txto asciidoc.conf
 308        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 309        $(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
 310                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
 311        mv $@+ $@
 312
 313manpage-base-url.xsl: manpage-base-url.xsl.in
 314        sed "s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|" $< > $@
 315
 316%.1 %.5 %.7 : %.xml manpage-base-url.xsl
 317        $(QUIET_XMLTO)$(RM) $@ && \
 318        $(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
 319
 320%.xml : %.txt asciidoc.conf
 321        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 322        $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
 323                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
 324        mv $@+ $@
 325
 326user-manual.xml: user-manual.txt user-manual.conf
 327        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 328        $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d article -o $@+ $< && \
 329        mv $@+ $@
 330
 331technical/api-index.txt: technical/api-index-skel.txt \
 332        technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
 333        $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh
 334
 335technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
 336$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt asciidoc.conf
 337        $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
 338                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
 339
 340XSLT = docbook.xsl
 341XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
 342
 343user-manual.html: user-manual.xml $(XSLT)
 344        $(QUIET_XSLTPROC)$(RM) $@+ $@ && \
 345        xsltproc $(XSLTOPTS) -o $@+ $(XSLT) $< && \
 346        mv $@+ $@
 347
 348git.info: user-manual.texi
 349        $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
 350
 351user-manual.texi: user-manual.xml
 352        $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
 353        $(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
 354        $(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
 355        rm $@++ && \
 356        mv $@+ $@
 357
 358user-manual.pdf: user-manual.xml
 359        $(QUIET_DBLATEX)$(RM) $@+ $@ && \
 360        $(DBLATEX) -o $@+ -p $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.xsl -s $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.sty $< && \
 361        mv $@+ $@
 362
 363gitman.texi: $(MAN_XML) cat-texi.perl
 364        $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
 365        ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
 366                --to-stdout $(xml) &&) true) > $@++ && \
 367        $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
 368        rm $@++ && \
 369        mv $@+ $@
 370
 371gitman.info: gitman.texi
 372        $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
 373
 374$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
 375        $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
 376        $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
 377        mv $@+ $@
 378
 379howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
 380        $(QUIET_GEN)$(RM) $@+ $@ && \
 381        '$(SHELL_PATH_SQ)' ./howto-index.sh $(sort $(wildcard howto/*.txt)) >$@+ && \
 382        mv $@+ $@
 383
 384$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
 385        $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 $*.txt
 386
 387WEBDOC_DEST = /pub/software/scm/git/docs
 388
 389howto/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
 390$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
 391        $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 392        sed -e '1,/^$$/d' $< | $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 - >$@+ && \
 393        mv $@+ $@
 394
 395install-webdoc : html
 396        '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
 397
 398# You must have a clone of 'git-htmldocs' and 'git-manpages' repositories
 399# next to the 'git' repository itself for the following to work.
 400
 401quick-install: quick-install-man
 402
 403require-manrepo::
 404        @if test ! -d $(MAN_REPO); \
 405        then echo "git-manpages repository must exist at $(MAN_REPO)"; exit 1; fi
 406
 407quick-install-man: require-manrepo
 408        '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(MAN_REPO) $(DESTDIR)$(mandir)
 409
 410require-htmlrepo::
 411        @if test ! -d $(HTML_REPO); \
 412        then echo "git-htmldocs repository must exist at $(HTML_REPO)"; exit 1; fi
 413
 414quick-install-html: require-htmlrepo
 415        '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REPO) $(DESTDIR)$(htmldir)
 416
 417print-man1:
 418        @for i in $(MAN1_TXT); do echo $$i; done
 419
 420.PHONY: FORCE