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