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

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