]> git.saurik.com Git - bison.git/blobdiff - doc/local.mk
projects / bison.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
muscle: enforce definition syntax for keyword variables
[bison.git] / doc / local.mk
diff --git a/doc/local.mk b/doc/local.mk
index d13979049f67edb464875f0c4421beb978fc7983..afd50dd113a649f78874c4c5915e0c9e3e45125b 100644 (file)
--- a/doc/local.mk
+++ b/doc/local.mk
@@ -1,5 +1,4 @@
-## Copyright (C) 2001, 2002, 2003, 2005, 2006, 2007, 2008 Free Software
-## Foundation, Inc.
+## Copyright (C) 2001-2003, 2005-2013 Free Software Foundation, Inc.
 
 ## This program is free software: you can redistribute it and/or modify
 ## it under the terms of the GNU General Public License as published by
 
 ## This program is free software: you can redistribute it and/or modify
 ## it under the terms of the GNU General Public License as published by
@@ -15,27 +14,38 @@
 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 AM_MAKEINFOFLAGS = --no-split
 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 AM_MAKEINFOFLAGS = --no-split
-info_TEXINFOS = doc/bison.texinfo
-doc_bison_TEXINFOS =                           \
-  $(CROSS_OPTIONS_TEXI)                                \
-  doc/fdl.texi                                 \
+info_TEXINFOS = doc/bison.texi
+doc_bison_TEXINFOS =                            \
+  $(CROSS_OPTIONS_TEXI)                         \
+  doc/fdl.texi                                  \
   doc/gpl-3.0.texi
 
   doc/gpl-3.0.texi
 
-CLEANFILES = doc/bison.fns
-CLEANDIRS = doc/*.t2d
+# Cannot express dependencies directly on file names because of Automake.
+# Obfuscate with a variable.
+doc_bison = doc/bison
+$(doc_bison).dvi: $(FIGS_DOT:.dot=.eps)
+$(doc_bison).pdf: $(FIGS_DOT:.dot=.pdf)
+$(doc_bison).html: $(FIGS_DOT:.dot=.png)
+
+TEXI2DVI = texi2dvi --build-dir=doc/bison.t2d -I doc
+CLEANDIRS = doc/bison.t2d
 clean-local:
        rm -rf $(CLEANDIRS)
 
 clean-local:
        rm -rf $(CLEANDIRS)
 
+MOSTLYCLEANFILES += $(top_srcdir)/doc/*.t
+
 CROSS_OPTIONS_PL = $(top_srcdir)/build-aux/cross-options.pl
 CROSS_OPTIONS_TEXI = $(top_srcdir)/doc/cross-options.texi
 CROSS_OPTIONS_PL = $(top_srcdir)/build-aux/cross-options.pl
 CROSS_OPTIONS_TEXI = $(top_srcdir)/doc/cross-options.texi
-$(CROSS_OPTIONS_TEXI): $(top_srcdir)/src/getargs.c $(CROSS_OPTIONS_PL)
-       mv -f $@ $@~ || : >$@~
-       -rm -f $@.tmp
-       $(MAKE) $(AM_MAKEFLAGS) src/bison$(EXEEXT)
-       $(top_builddir)/src/bison --help |                              \
-       perl $(CROSS_OPTIONS_PL) $(top_srcdir)/src/scan-gram.l >$@.tmp
-       diff -u $@~ $@.tmp || true
-       mv $@.tmp $@
+$(CROSS_OPTIONS_TEXI): doc/bison.help $(CROSS_OPTIONS_PL)
+# Create $@~ which is the previous contents.  Don't use 'mv' here so
+# that even if we are interrupted, the file is still available for
+# diff in the next run.  Note that $@ might not exist yet.
+       $(AM_V_GEN){ test ! -f $@ || cat $@; } >$@~
+       $(AM_V_at)test ! -f $@.tmp || rm -f $@.tmp
+       $(AM_V_at)src/bison$(EXEEXT) --help |                            \
+         $(PERL) $(CROSS_OPTIONS_PL) $(top_srcdir)/src/scan-gram.l >$@.tmp
+       $(AM_V_at)diff -u $@~ $@.tmp || true
+       $(AM_V_at)mv $@.tmp $@
 MAINTAINERCLEANFILES = $(CROSS_OPTIONS_TEXI)
 
 ## ---------- ##
 MAINTAINERCLEANFILES = $(CROSS_OPTIONS_TEXI)
 
 ## ---------- ##
@@ -43,12 +53,42 @@ MAINTAINERCLEANFILES = $(CROSS_OPTIONS_TEXI)
 ## ---------- ##
 
 EXTRA_DIST += doc/refcard.tex
 ## ---------- ##
 
 EXTRA_DIST += doc/refcard.tex
-CLEANFILES += doc/refcard.dvi doc/refcard.log doc/refcard.ps
-
-doc/refcard.dvi: doc/refcard.tex
-       cd doc && tex refcard.tex
-
-doc/refcard.ps: doc/refcard.dvi
+CLEANFILES += doc/refcard.pdf
+
+doc/refcard.pdf: doc/refcard.tex
+       $(AM_V_GEN) cd doc && pdftex $(abs_top_srcdir)/doc/refcard.tex
+
+
+
+## ---------------- ##
+## doc/bison.help.  ##
+## ---------------- ##
+
+# Some of our targets (cross-option.texi, bison.1) use "bison --help".
+# Since we want to ship the generated file to avoid additional
+# requirements over the user environment, we used not depend on
+# src/bison itself, but on src/getargs.c and other files.  Yet, we
+# need "bison --help" to work to make help2man happy, so we used to
+# include "make src/bison" in the commands.  Then we may have a
+# problem with concurrent builds, since one make might be aiming one
+# of its jobs at compiling src/bison, and another job at generating
+# the man page.  If the latter is faster than the former, then we have
+# two makes that concurrently try to compile src/bison.  Doomed to
+# failure.
+#
+# As a simple scheme to get our way out, make a stamp file,
+# bison.help, which contains --version then --help.  This file can
+# depend on bison, which ensures its correctness.  But update it
+# *only* if needed (content changes).  This way, we avoid useless
+# compilations of cross-option.texi and bison.1.  At the cost of
+# repeated builds of bison.help.
+
+EXTRA_DIST += $(top_srcdir)/doc/bison.help
+MAINTAINERCLEANFILES += $(top_srcdir)/doc/bison.help
+$(top_srcdir)/doc/bison.help: src/bison$(EXEEXT)
+       $(AM_V_GEN)src/bison$(EXEEXT) --version >doc/bison.help.tmp
+       $(AM_V_at) src/bison$(EXEEXT) --help   >>doc/bison.help.tmp
+       $(AM_V_at)$(top_srcdir)/build-aux/move-if-change doc/bison.help.tmp $@
 
 
 ## ----------- ##
 
 
 ## ----------- ##
@@ -57,48 +97,56 @@ doc/refcard.ps: doc/refcard.dvi
 
 dist_man_MANS = $(top_srcdir)/doc/bison.1
 
 
 dist_man_MANS = $(top_srcdir)/doc/bison.1
 
-EXTRA_DIST += $(dist_man_MANS:.1=.x) doc/common.x
+EXTRA_DIST += $(dist_man_MANS:.1=.x)
 MAINTAINERCLEANFILES += $(dist_man_MANS)
 
 MAINTAINERCLEANFILES += $(dist_man_MANS)
 
-# Depend on configure to get version number changes.
-common_dep = $(top_srcdir)/configure $(top_srcdir)/doc/common.x
-$(top_srcdir)/doc/bison.1:      $(common_dep) $(top_srcdir)/src/getargs.c
-
 # Differences to ignore when comparing the man page (the date).
 remove_time_stamp = \
   sed 's/^\(\.TH[^"]*"[^"]*"[^"]*\)"[^"]*"/\1/'
 
 # Differences to ignore when comparing the man page (the date).
 remove_time_stamp = \
   sed 's/^\(\.TH[^"]*"[^"]*"[^"]*\)"[^"]*"/\1/'
 
-MOSTLYCLEANFILES += $(top_srcdir)/doc/*.t
-
-SUFFIXES = .x .1
-
-PREPATH = src
-.x.1:
-       @program=`expr "/$*" : '.*/\(.*\)'` &&                           \
-       save_IFS=$IFS;                                                   \
-       IFS=$(PATH_SEPARATOR);                                           \
-       for dir in $(PREPATH); do                                        \
-         IFS=$save_IFS;                                                 \
-         echo $(MAKE) $(AM_MAKEFLAGS) $$dir/$$program;                  \
-         $(MAKE) $(AM_MAKEFLAGS) $$dir/$$program || exit;               \
-       done
-       @echo "Updating man page $@"
-       PATH="$(top_builddir)/$(PREPATH)$(PATH_SEPARATOR)$$PATH";        \
-       export PATH;                                                     \
-       $(HELP2MAN)                                                      \
-           --include=$*.x                                               \
-           --include=$(top_srcdir)/doc/common.x                         \
-           --output=$@.t `echo '$*' | sed 's,.*/,,'`
-       if $(remove_time_stamp) $@ >$@a.t 2>/dev/null &&                 \
+# Depend on configure to get version number changes.
+$(top_srcdir)/doc/bison.1: doc/bison.help doc/bison.x $(top_srcdir)/configure
+       $(AM_V_GEN)$(HELP2MAN)                  \
+           --include=$(top_srcdir)/doc/bison.x \
+           --output=$@.t src/bison$(EXEEXT)
+       $(AM_V_at)if $(remove_time_stamp) $@ >$@a.t 2>/dev/null &&       \
           $(remove_time_stamp) $@.t | cmp $@a.t - >/dev/null 2>&1; then \
           $(remove_time_stamp) $@.t | cmp $@a.t - >/dev/null 2>&1; then \
-               touch $@;                                                \
+         touch $@;                                                      \
        else                                                             \
        else                                                             \
-               mv $@.t $@;                                              \
+         mv $@.t $@;                                                    \
        fi
        fi
-       rm -f $@*.t
+       $(AM_V_at)rm -f $@*.t
 
 nodist_man_MANS = doc/yacc.1
 
 
 nodist_man_MANS = doc/yacc.1
 
+## ----------------------------- ##
+## Graphviz examples generation. ##
+## ----------------------------- ##
+
+CLEANDIRS += doc/figs
+FIGS_DOT =                                                      \
+  doc/figs/example.dot                                          \
+  doc/figs/example-reduce.dot doc/figs/example-shift.dot
+EXTRA_DIST +=                                                           \
+  $(FIGS_DOT)                                                           \
+  $(FIGS_DOT:.dot=.eps) $(FIGS_DOT:.dot=.pdf) $(FIGS_DOT:.dot=.png)
+SUFFIXES += .dot .eps .pdf .png
+
+.dot.eps:
+       $(AM_V_GEN) $(MKDIR_P) `echo "./$@" | sed -e 's,/[^/]*$$,,'`
+       $(AM_V_at) $(DOT) -Gmargin=0 -Teps $< >$@.tmp
+       $(AM_V_at) mv $@.tmp $@
+
+.dot.pdf:
+       $(AM_V_GEN) $(MKDIR_P) `echo "./$@" | sed -e 's,/[^/]*$$,,'`
+       $(AM_V_at) $(DOT) -Gmargin=0 -Tpdf $< >$@.tmp
+       $(AM_V_at) mv $@.tmp $@
+
+.dot.png:
+       $(AM_V_GEN) $(MKDIR_P) `echo "./$@" | sed -e 's,/[^/]*$$,,'`
+       $(AM_V_at) $(DOT) -Gmargin=0 -Tpng $< >$@.tmp
+       $(AM_V_at) mv $@.tmp $@
+
 ## -------------- ##
 ## Doxygenation.  ##
 ## -------------- ##
 ## -------------- ##
 ## Doxygenation.  ##
 ## -------------- ##
@@ -110,10 +158,11 @@ DOXYGEN = doxygen
 doc: html
 
 html-local: doc/Doxyfile
 doc: html
 
 html-local: doc/Doxyfile
-       cd doc && $(DOXYGEN)
+       $(AM_V_GEN) $(DOXYGEN) doc/Doxyfile
 
 edit = sed -e 's,@PACKAGE_NAME\@,$(PACKAGE_NAME),g' \
           -e 's,@PACKAGE_VERSION\@,$(PACKAGE_VERSION),g' \
 
 edit = sed -e 's,@PACKAGE_NAME\@,$(PACKAGE_NAME),g' \
           -e 's,@PACKAGE_VERSION\@,$(PACKAGE_VERSION),g' \
+          -e 's,@PERL\@,$(PERL),g' \
           -e 's,@top_builddir\@,$(top_builddir),g' \
           -e 's,@top_srcdir\@,$(top_srcdir),g'
 
           -e 's,@top_builddir\@,$(top_builddir),g' \
           -e 's,@top_srcdir\@,$(top_srcdir),g'
 
@@ -122,6 +171,6 @@ CLEANFILES += doc/Doxyfile
 # Sed is used to generate Doxyfile from Doxyfile.in instead of
 # configure, because the former is way faster than the latter.
 doc/Doxyfile: $(top_srcdir)/doc/Doxyfile.in
 # Sed is used to generate Doxyfile from Doxyfile.in instead of
 # configure, because the former is way faster than the latter.
 doc/Doxyfile: $(top_srcdir)/doc/Doxyfile.in
-       $(edit) $(top_srcdir)/doc/Doxyfile.in >doc/Doxyfile
+       $(AM_V_GEN) $(edit) $(top_srcdir)/doc/Doxyfile.in >doc/Doxyfile
 
 
-CLEANDIRS += html latex
+CLEANDIRS += doc/html
bison