Documentation/Makefile

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