Merge branch 'cj/doc-quiet' into cj/doc-format
authorJunio C Hamano <gitster@pobox.com>
Fri, 27 Mar 2009 07:36:47 +0000 (00:36 -0700)
committerJunio C Hamano <gitster@pobox.com>
Fri, 27 Mar 2009 07:36:47 +0000 (00:36 -0700)
* cj/doc-quiet:
Documentation/Makefile: break up texi pipeline
Documentation/Makefile: make most operations "quiet"

Conflicts:
Documentation/Makefile

1  2 
Documentation/Makefile
diff --combined Documentation/Makefile
index 1c94531874f6f525de94ef183c989a26b034aba5,d145372393e98afe0c10aa7a14cb3f0f5649ebf1..dae31746675ce2699204ad5645e03785469a16c2
@@@ -41,8 -41,7 +41,8 @@@ man7dir=$(mandir)/man
  
  ASCIIDOC=asciidoc
  ASCIIDOC_EXTRA =
 -MANPAGE_XSL = callouts.xsl
 +MANPAGE_XSL = manpage-normal.xsl
 +XMLTO_EXTRA =
  INSTALL?=install
  RM ?= rm -f
  DOC_REF = origin/man
@@@ -60,42 -59,12 +60,42 @@@ endi
  -include ../config.mak.autogen
  -include ../config.mak
  
 +#
 +# For asciidoc ...
 +#     -7.1.2, no extra settings are needed.
 +#     8.0-,   set ASCIIDOC8.
 +#
 +
 +#
 +# For docbook-xsl ...
 +#     -1.68.1,        set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0)
 +#     1.69.0-1.71.1,  no extra settings are needed?
 +#     1.72.0,         set DOCBOOK_XSL_172.
 +#     1.73.0-,        set ASCIIDOC_NO_ROFF
 +#
 +
 +#
 +# If you had been using DOCBOOK_XSL_172 in an attempt to get rid
 +# of 'the ".ft C" problem' in your generated manpages, and you
 +# instead ended up with weird characters around callouts, try
 +# using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8).
 +#
 +
  ifdef ASCIIDOC8
  ASCIIDOC_EXTRA += -a asciidoc7compatible
  endif
  ifdef DOCBOOK_XSL_172
 -ASCIIDOC_EXTRA += -a docbook-xsl-172
 +ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
  MANPAGE_XSL = manpage-1.72.xsl
 +else
 +      ifdef ASCIIDOC_NO_ROFF
 +      # docbook-xsl after 1.72 needs the regular XSL, but will not
 +      # pass-thru raw roff codes from asciidoc.conf, so turn them off.
 +      ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
 +      endif
 +endif
 +ifdef MAN_BOLD_LITERAL
 +XMLTO_EXTRA += -m manpage-bold-literal.xsl
  endif
  
  #
  # yourself - yes, all 6 characters of it!
  #
  
+ QUIET_SUBDIR0  = +$(MAKE) -C # space to separate -C and subdir
+ QUIET_SUBDIR1  =
+ ifneq ($(findstring $(MAKEFLAGS),w),w)
+ PRINT_DIR = --no-print-directory
+ else # "make -w"
+ NO_SUBDIR = :
+ endif
+ ifneq ($(findstring $(MAKEFLAGS),s),s)
+ ifndef V
+       QUIET_ASCIIDOC  = @echo '   ' ASCIIDOC $@;
+       QUIET_XMLTO     = @echo '   ' XMLTO $@;
+       QUIET_DB2TEXI   = @echo '   ' DB2TEXI $@;
+       QUIET_MAKEINFO  = @echo '   ' MAKEINFO $@;
+       QUIET_DBLATEX   = @echo '   ' DBLATEX $@;
+       QUIET_XSLTPROC  = @echo '   ' XSLTPROC $@;
+       QUIET_GEN       = @echo '   ' GEN $@;
+       QUIET_STDERR    = 2> /dev/null
+       QUIET_SUBDIR0   = +@subdir=
+       QUIET_SUBDIR1   = ;$(NO_SUBDIR) echo '   ' SUBDIR $$subdir; \
+                         $(MAKE) $(PRINT_DIR) -C $$subdir
+       export V
+ endif
+ endif
  all: html man
  
  html: $(DOC_HTML)
@@@ -150,7 -145,7 +176,7 @@@ install-html: htm
        sh ./install-webdoc.sh $(DESTDIR)$(htmldir)
  
  ../GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
-       $(MAKE) -C ../ GIT-VERSION-FILE
+       $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
  
  -include ../GIT-VERSION-FILE
  
  # Determine "include::" file references in asciidoc files.
  #
  doc.dep : $(wildcard *.txt) build-docdep.perl
-       $(RM) $@+ $@
-       $(PERL_PATH) ./build-docdep.perl >$@+
+       $(QUIET_GEN)$(RM) $@+ $@ && \
+       $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
        mv $@+ $@
  
  -include doc.dep
@@@ -177,91 -172,94 +203,94 @@@ cmds_txt = cmds-ancillaryinterrogators.
  $(cmds_txt): cmd-list.made
  
  cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
-       $(RM) $@
-       $(PERL_PATH) ./cmd-list.perl ../command-list.txt
+       $(QUIET_GEN)$(RM) $@ && \
+       $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
        date >$@
  
  clean:
        $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
-       $(RM) *.texi *.texi+ git.info gitman.info
+       $(RM) *.texi *.texi+ *.texi++ git.info gitman.info
        $(RM) howto-index.txt howto/*.html doc.dep
        $(RM) technical/api-*.html technical/api-index.txt
        $(RM) $(cmds_txt) *.made
  
  $(MAN_HTML): %.html : %.txt
-       $(RM) $@+ $@
+       $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
        $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
-               $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $<
+               $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
        mv $@+ $@
  
  %.1 %.5 %.7 : %.xml
-       $(RM) $@
+       $(QUIET_XMLTO)$(RM) $@ && \
 -      xmlto -m $(MANPAGE_XSL) man $<
 +      xmlto -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
  
  %.xml : %.txt
-       $(RM) $@+ $@
+       $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
        $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
-               $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $<
+               $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
        mv $@+ $@
  
  user-manual.xml: user-manual.txt user-manual.conf
-       $(ASCIIDOC) -b docbook -d book $<
+       $(QUIET_ASCIIDOC)$(ASCIIDOC) -b docbook -d book $<
  
  technical/api-index.txt: technical/api-index-skel.txt \
        technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
-       cd technical && sh ./api-index.sh
+       $(QUIET_GEN)cd technical && sh ./api-index.sh
  
  $(patsubst %,%.html,$(API_DOCS) technical/api-index): %.html : %.txt
-       $(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
+       $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
                $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
  
  XSLT = docbook.xsl
  XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
  
  user-manual.html: user-manual.xml
-       xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
+       $(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
  
  git.info: user-manual.texi
-       $(MAKEINFO) --no-split -o $@ user-manual.texi
+       $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
  
  user-manual.texi: user-manual.xml
-       $(RM) $@+ $@
-       $(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout | \
-               $(PERL_PATH) fix-texi.perl >$@+
+       $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
+       $(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
+       $(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
+       rm $@++ && \
        mv $@+ $@
  
  user-manual.pdf: user-manual.xml
-       $(RM) $@+ $@
-       $(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $<
+       $(QUIET_DBLATEX)$(RM) $@+ $@ && \
+       $(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $< && \
        mv $@+ $@
  
  gitman.texi: $(MAN_XML) cat-texi.perl
-       $(RM) $@+ $@
+       $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
        ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
-               --to-stdout $(xml);)) | $(PERL_PATH) cat-texi.perl $@ >$@+
+               --to-stdout $(xml) &&) true) > $@++ && \
+       $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
+       rm $@++ && \
        mv $@+ $@
  
  gitman.info: gitman.texi
-       $(MAKEINFO) --no-split --no-validate $*.texi
+       $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
  
  $(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
-       $(RM) $@+ $@
-       $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+
+       $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
+       $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
        mv $@+ $@
  
  howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
-       $(RM) $@+ $@
-       sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
+       $(QUIET_GEN)$(RM) $@+ $@ && \
+       sh ./howto-index.sh $(wildcard howto/*.txt) >$@+ && \
        mv $@+ $@
  
  $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
-       $(ASCIIDOC) -b xhtml11 $*.txt
+       $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 $*.txt
  
  WEBDOC_DEST = /pub/software/scm/git/docs
  
  $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
-       $(RM) $@+ $@
-       sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b xhtml11 - >$@+
+       $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
+       sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b xhtml11 - >$@+ && \
        mv $@+ $@
  
  install-webdoc : html