Documentation/Makefile

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