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