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

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