Documentation/Makefile

   1 MAN1_TXT= \
   2         $(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
   3                 $(wildcard git-*.txt)) \
   4         gitk.txt git.txt
   5 MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt \
   6         gitrepository-layout.txt
   7 MAN7_TXT=gitcli.txt gittutorial.txt gittutorial-2.txt \
   8         gitcvs-migration.txt gitcore-tutorial.txt gitglossary.txt \
   9         gitdiffcore.txt gitworkflows.txt
  10
  11 MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
  12 MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
  13 MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
  14
  15 DOC_HTML=$(MAN_HTML)
  16
  17 ARTICLES = howto-index
  18 ARTICLES += everyday
  19 ARTICLES += git-tools
  20 # with their own formatting rules.
  21 SP_ARTICLES = howto/revert-branch-rebase howto/using-merge-subtree user-manual
  22 API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
  23 SP_ARTICLES += $(API_DOCS)
  24 SP_ARTICLES += technical/api-index
  25
  26 DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
  27
  28 DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
  29 DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT))
  30 DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
  31
  32 prefix?=$(HOME)
  33 bindir?=$(prefix)/bin
  34 htmldir?=$(prefix)/share/doc/git-doc
  35 pdfdir?=$(prefix)/share/doc/git-doc
  36 mandir?=$(prefix)/share/man
  37 man1dir=$(mandir)/man1
  38 man5dir=$(mandir)/man5
  39 man7dir=$(mandir)/man7
  40 # DESTDIR=
  41
  42 ASCIIDOC=asciidoc
  43 ASCIIDOC_EXTRA =
  44 MANPAGE_XSL = manpage-normal.xsl
  45 XMLTO_EXTRA =
  46 INSTALL?=install
  47 RM ?= rm -f
  48 DOC_REF = origin/man
  49 HTML_REF = origin/html
  50
  51 infodir?=$(prefix)/share/info
  52 MAKEINFO=makeinfo
  53 INSTALL_INFO=install-info
  54 DOCBOOK2X_TEXI=docbook2x-texi
  55 DBLATEX=dblatex
  56 ifndef PERL_PATH
  57         PERL_PATH = /usr/bin/perl
  58 endif
  59
  60 -include ../config.mak.autogen
  61 -include ../config.mak
  62
  63 #
  64 # For asciidoc ...
  65 #       -7.1.2, no extra settings are needed.
  66 #       8.0-,   set ASCIIDOC8.
  67 #
  68
  69 #
  70 # For docbook-xsl ...
  71 #       -1.68.1,        set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0)
  72 #       1.69.0,         no extra settings are needed?
  73 #       1.69.1-1.71.0,  set DOCBOOK_SUPPRESS_SP?
  74 #       1.71.1,         no extra settings are needed?
  75 #       1.72.0,         set DOCBOOK_XSL_172.
  76 #       1.73.0-,        set ASCIIDOC_NO_ROFF
  77 #
  78
  79 #
  80 # If you had been using DOCBOOK_XSL_172 in an attempt to get rid
  81 # of 'the ".ft C" problem' in your generated manpages, and you
  82 # instead ended up with weird characters around callouts, try
  83 # using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8).
  84 #
  85
  86 ifdef ASCIIDOC8
  87 ASCIIDOC_EXTRA += -a asciidoc7compatible -a no-inline-literal
  88 endif
  89 ifdef DOCBOOK_XSL_172
  90 ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
  91 MANPAGE_XSL = manpage-1.72.xsl
  92 else
  93         ifdef ASCIIDOC_NO_ROFF
  94         # docbook-xsl after 1.72 needs the regular XSL, but will not
  95         # pass-thru raw roff codes from asciidoc.conf, so turn them off.
  96         ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
  97         endif
  98 endif
  99 ifdef MAN_BOLD_LITERAL
 100 XMLTO_EXTRA += -m manpage-bold-literal.xsl
 101 endif
 102 ifdef DOCBOOK_SUPPRESS_SP
 103 XMLTO_EXTRA += -m manpage-suppress-sp.xsl
 104 endif
 105
 106 SHELL_PATH ?= $(SHELL)
 107 # Shell quote;
 108 SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
 109
 110 #
 111 # Please note that there is a minor bug in asciidoc.
 112 # The version after 6.0.3 _will_ include the patch found here:
 113 #   http://marc.theaimsgroup.com/?l=git&m=111558757202243&w=2
 114 #
 115 # Until that version is released you may have to apply the patch
 116 # yourself - yes, all 6 characters of it!
 117 #
 118
 119 QUIET_SUBDIR0  = +$(MAKE) -C # space to separate -C and subdir
 120 QUIET_SUBDIR1  =
 121
 122 ifneq ($(findstring $(MAKEFLAGS),w),w)
 123 PRINT_DIR = --no-print-directory
 124 else # "make -w"
 125 NO_SUBDIR = :
 126 endif
 127
 128 ifneq ($(findstring $(MAKEFLAGS),s),s)
 129 ifndef V
 130         QUIET_ASCIIDOC  = @echo '   ' ASCIIDOC $@;
 131         QUIET_XMLTO     = @echo '   ' XMLTO $@;
 132         QUIET_DB2TEXI   = @echo '   ' DB2TEXI $@;
 133         QUIET_MAKEINFO  = @echo '   ' MAKEINFO $@;
 134         QUIET_DBLATEX   = @echo '   ' DBLATEX $@;
 135         QUIET_XSLTPROC  = @echo '   ' XSLTPROC $@;
 136         QUIET_GEN       = @echo '   ' GEN $@;
 137         QUIET_STDERR    = 2> /dev/null
 138         QUIET_SUBDIR0   = +@subdir=
 139         QUIET_SUBDIR1   = ;$(NO_SUBDIR) echo '   ' SUBDIR $$subdir; \
 140                           $(MAKE) $(PRINT_DIR) -C $$subdir
 141         export V
 142 endif
 143 endif
 144
 145 all: html man
 146
 147 html: $(DOC_HTML)
 148
 149 $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
 150
 151 man: man1 man5 man7
 152 man1: $(DOC_MAN1)
 153 man5: $(DOC_MAN5)
 154 man7: $(DOC_MAN7)
 155
 156 info: git.info gitman.info
 157
 158 pdf: user-manual.pdf
 159
 160 install: install-man
 161
 162 install-man: man
 163         $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
 164         $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
 165         $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
 166         $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
 167         $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
 168         $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
 169
 170 install-info: info
 171         $(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
 172         $(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
 173         if test -r $(DESTDIR)$(infodir)/dir; then \
 174           $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
 175           $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
 176         else \
 177           echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
 178         fi
 179
 180 install-pdf: pdf
 181         $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
 182         $(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)
 183
 184 install-html: html
 185         '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
 186
 187 ../GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
 188         $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
 189
 190 -include ../GIT-VERSION-FILE
 191
 192 #
 193 # Determine "include::" file references in asciidoc files.
 194 #
 195 doc.dep : $(wildcard *.txt) build-docdep.perl
 196         $(QUIET_GEN)$(RM) $@+ $@ && \
 197         $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
 198         mv $@+ $@
 199
 200 -include doc.dep
 201
 202 cmds_txt = cmds-ancillaryinterrogators.txt \
 203         cmds-ancillarymanipulators.txt \
 204         cmds-mainporcelain.txt \
 205         cmds-plumbinginterrogators.txt \
 206         cmds-plumbingmanipulators.txt \
 207         cmds-synchingrepositories.txt \
 208         cmds-synchelpers.txt \
 209         cmds-purehelpers.txt \
 210         cmds-foreignscminterface.txt
 211
 212 $(cmds_txt): cmd-list.made
 213
 214 cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
 215         $(QUIET_GEN)$(RM) $@ && \
 216         $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
 217         date >$@
 218
 219 clean:
 220         $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
 221         $(RM) *.texi *.texi+ *.texi++ git.info gitman.info
 222         $(RM) howto-index.txt howto/*.html doc.dep
 223         $(RM) technical/api-*.html technical/api-index.txt
 224         $(RM) $(cmds_txt) *.made
 225
 226 $(MAN_HTML): %.html : %.txt
 227         $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 228         $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
 229                 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
 230         mv $@+ $@
 231
 232 %.1 %.5 %.7 : %.xml
 233         $(QUIET_XMLTO)$(RM) $@ && \
 234         xmlto -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
 235
 236 %.xml : %.txt
 237         $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 238         $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
 239                 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
 240         mv $@+ $@
 241
 242 user-manual.xml: user-manual.txt user-manual.conf
 243         $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d book $<
 244
 245 technical/api-index.txt: technical/api-index-skel.txt \
 246         technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
 247         $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh
 248
 249 $(patsubst %,%.html,$(API_DOCS) technical/api-index): %.html : %.txt
 250         $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
 251                 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
 252
 253 XSLT = docbook.xsl
 254 XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
 255
 256 user-manual.html: user-manual.xml
 257         $(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
 258
 259 git.info: user-manual.texi
 260         $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
 261
 262 user-manual.texi: user-manual.xml
 263         $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
 264         $(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
 265         $(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
 266         rm $@++ && \
 267         mv $@+ $@
 268
 269 user-manual.pdf: user-manual.xml
 270         $(QUIET_DBLATEX)$(RM) $@+ $@ && \
 271         $(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $< && \
 272         mv $@+ $@
 273
 274 gitman.texi: $(MAN_XML) cat-texi.perl
 275         $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
 276         ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
 277                 --to-stdout $(xml) &&) true) > $@++ && \
 278         $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
 279         rm $@++ && \
 280         mv $@+ $@
 281
 282 gitman.info: gitman.texi
 283         $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
 284
 285 $(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
 286         $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
 287         $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
 288         mv $@+ $@
 289
 290 howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
 291         $(QUIET_GEN)$(RM) $@+ $@ && \
 292         '$(SHELL_PATH_SQ)' ./howto-index.sh $(wildcard howto/*.txt) >$@+ && \
 293         mv $@+ $@
 294
 295 $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
 296         $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 $*.txt
 297
 298 WEBDOC_DEST = /pub/software/scm/git/docs
 299
 300 $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
 301         $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
 302         sed -e '1,/^$$/d' $< | $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 - >$@+ && \
 303         mv $@+ $@
 304
 305 install-webdoc : html
 306         '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
 307
 308 quick-install: quick-install-man
 309
 310 quick-install-man:
 311         '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)
 312
 313 quick-install-html:
 314         '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REF) $(DESTDIR)$(htmldir)
 315
 316 .PHONY: .FORCE-GIT-VERSION-FILE