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

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