doc/local.mk

   1 ## Copyright (C) 2001-2003, 2005-2012 Free Software Foundation, Inc.
   2
   3 ## This program is free software: you can redistribute it and/or modify
   4 ## it under the terms of the GNU General Public License as published by
   5 ## the Free Software Foundation, either version 3 of the License, or
   6 ## (at your option) any later version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful,
   9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 ## GNU General Public License for more details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License
  14 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15
  16 AM_MAKEINFOFLAGS = --no-split
  17 info_TEXINFOS = doc/bison.texi
  18 doc_bison_TEXINFOS =                            \
  19   $(CROSS_OPTIONS_TEXI)                         \
  20   doc/fdl.texi                                  \
  21   doc/gpl-3.0.texi
  22
  23 TEXI2DVI = texi2dvi --build-dir=doc/bison.t2d
  24 CLEANDIRS = doc/bison.t2d
  25 clean-local:
  26         rm -rf $(CLEANDIRS)
  27
  28 MOSTLYCLEANFILES += $(top_srcdir)/doc/*.t
  29
  30 CROSS_OPTIONS_PL = $(top_srcdir)/build-aux/cross-options.pl
  31 CROSS_OPTIONS_TEXI = $(top_srcdir)/doc/cross-options.texi
  32 $(CROSS_OPTIONS_TEXI): doc/bison.help $(CROSS_OPTIONS_PL)
  33 # Create $@~ which is the previous contents.  Don't use `mv' here so
  34 # that even if we are interrupted, the file is still available for
  35 # diff in the next run.  Note that $@ might not exist yet.
  36         $(AM_V_GEN){ test ! -f $@ || cat $@; } >$@~
  37         $(AM_V_at)test ! -f $@.tmp || rm -f $@.tmp
  38         $(AM_V_at)src/bison$(EXEEXT) --help |                            \
  39           $(PERL) $(CROSS_OPTIONS_PL) $(top_srcdir)/src/scan-gram.l >$@.tmp
  40         $(AM_V_at)diff -u $@~ $@.tmp || true
  41         $(AM_V_at)mv $@.tmp $@
  42 MAINTAINERCLEANFILES = $(CROSS_OPTIONS_TEXI)
  43
  44 ## ---------- ##
  45 ## Ref card.  ##
  46 ## ---------- ##
  47
  48 EXTRA_DIST += doc/refcard.tex
  49 CLEANFILES += doc/refcard.pdf
  50
  51 doc/refcard.pdf: doc/refcard.tex
  52         $(AM_V_GEN) cd doc && pdftex $(abs_top_srcdir)/doc/refcard.tex
  53
  54
  55
  56 ## ---------------- ##
  57 ## doc/bison.help.  ##
  58 ## ---------------- ##
  59
  60 # Some of our targets (cross-option.texi, bison.1) use "bison --help".
  61 # Since we want to ship the generated file to avoid additional
  62 # requirements over the user environment, we used not depend on
  63 # src/bison itself, but on src/getargs.c and other files.  Yet, we
  64 # need "bison --help" to work to make help2man happy, so we used to
  65 # include "make src/bison" in the commands.  Then we may have a
  66 # problem with concurrent builds, since one make might be aiming one
  67 # of its jobs at compiling src/bison, and another job at generating
  68 # the man page.  If the latter is faster than the former, then we have
  69 # two makes that concurrently try to compile src/bison.  Doomed to
  70 # failure.
  71 #
  72 # As a simple scheme to get our way out, make a stamp file,
  73 # bison.help, which contains --version then --help.  This file can
  74 # depend on bison, which ensures its correctness.  But update it
  75 # *only* if needed (content changes).  This way, we avoid useless
  76 # compilations of cross-option.texi and bison.1.  At the cost of
  77 # repeated builds of bison.help.
  78
  79 EXTRA_DIST += $(top_srcdir)/doc/bison.help
  80 MAINTAINERCLEANFILES += $(top_srcdir)/doc/bison.help
  81 $(top_srcdir)/doc/bison.help: src/bison$(EXEEXT)
  82         $(AM_V_GEN)src/bison$(EXEEXT) --version >doc/bison.help.tmp
  83         $(AM_V_at) src/bison$(EXEEXT) --help   >>doc/bison.help.tmp
  84         $(AM_V_at)$(top_srcdir)/build-aux/move-if-change doc/bison.help.tmp $@
  85
  86
  87 ## ----------- ##
  88 ## Man Pages.  ##
  89 ## ----------- ##
  90
  91 dist_man_MANS = $(top_srcdir)/doc/bison.1
  92
  93 EXTRA_DIST += $(dist_man_MANS:.1=.x)
  94 MAINTAINERCLEANFILES += $(dist_man_MANS)
  95
  96 # Differences to ignore when comparing the man page (the date).
  97 remove_time_stamp = \
  98   sed 's/^\(\.TH[^"]*"[^"]*"[^"]*\)"[^"]*"/\1/'
  99
 100 # Depend on configure to get version number changes.
 101 $(top_srcdir)/doc/bison.1: doc/bison.help doc/bison.x $(top_srcdir)/configure
 102         $(AM_V_GEN)$(HELP2MAN)                  \
 103             --include=$(top_srcdir)/doc/bison.x \
 104             --output=$@.t src/bison$(EXEEXT)
 105         $(AM_V_at)if $(remove_time_stamp) $@ >$@a.t 2>/dev/null &&       \
 106            $(remove_time_stamp) $@.t | cmp $@a.t - >/dev/null 2>&1; then \
 107           touch $@;                                                      \
 108         else                                                             \
 109           mv $@.t $@;                                                    \
 110         fi
 111         $(AM_V_at)rm -f $@*.t
 112
 113 nodist_man_MANS = doc/yacc.1
 114
 115 ## ----------------------------- ##
 116 ## Graphviz examples generation. ##
 117 ## ----------------------------- ##
 118
 119 CLEANDIRS += doc/figs
 120 FIGS_DOT = doc/figs/example-reduce.dot doc/figs/example-shift.dot
 121 EXTRA_DIST +=                                                           \
 122   $(FIGS_DOT)                                                           \
 123   $(FIGS_DOT:.dot=.eps) $(FIGS_DOT:.dot=.pdf) $(FIGS_DOT:.dot=.png)
 124 SUFFIXES += .dot .eps .pdf .png
 125
 126 doc/bison.dvi:  $(FIGS_DOT:.dot=.eps)
 127 doc/bison.html: $(FIGS_DOT:.dot=.png)
 128 doc/bison.pdf:  $(FIGS_DOT:.dot=.pdf)
 129
 130 .dot.eps:
 131         $(AM_V_GEN) $(MKDIR_P) `echo "./$@" | sed -e 's,/[^/]*$$,,'`
 132         $(AM_V_at) $(DOT) -Gmargin=0 -Teps $< >$@.tmp
 133         $(AM_V_at) mv $@.tmp $@
 134
 135 .dot.pdf:
 136         $(AM_V_GEN) $(MKDIR_P) `echo "./$@" | sed -e 's,/[^/]*$$,,'`
 137         $(AM_V_at) $(DOT) -Gmargin=0 -Tpdf $< >$@.tmp
 138         $(AM_V_at) mv $@.tmp $@
 139
 140 .dot.png:
 141         $(AM_V_GEN) $(MKDIR_P) `echo "./$@" | sed -e 's,/[^/]*$$,,'`
 142         $(AM_V_at) $(DOT) -Gmargin=0 -Tpng $< >$@.tmp
 143         $(AM_V_at) mv $@.tmp $@
 144
 145 ## -------------- ##
 146 ## Doxygenation.  ##
 147 ## -------------- ##
 148
 149 DOXYGEN = doxygen
 150
 151 .PHONY: doc html
 152
 153 doc: html
 154
 155 html-local: doc/Doxyfile
 156         $(AM_V_GEN) $(DOXYGEN) doc/Doxyfile
 157
 158 edit = sed -e 's,@PACKAGE_NAME\@,$(PACKAGE_NAME),g' \
 159            -e 's,@PACKAGE_VERSION\@,$(PACKAGE_VERSION),g' \
 160            -e 's,@PERL\@,$(PERL),g' \
 161            -e 's,@top_builddir\@,$(top_builddir),g' \
 162            -e 's,@top_srcdir\@,$(top_srcdir),g'
 163
 164 EXTRA_DIST += doc/Doxyfile.in
 165 CLEANFILES += doc/Doxyfile
 166 # Sed is used to generate Doxyfile from Doxyfile.in instead of
 167 # configure, because the former is way faster than the latter.
 168 doc/Doxyfile: $(top_srcdir)/doc/Doxyfile.in
 169         $(AM_V_GEN) $(edit) $(top_srcdir)/doc/Doxyfile.in >doc/Doxyfile
 170
 171 CLEANDIRS += doc/html