doc/local.mk

   1 ## Copyright (C) 2001-2003, 2005-2013 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 # Cannot express dependencies directly on file names because of Automake.
  24 # Obfuscate with a variable.
  25 doc_bison = doc/bison
  26 $(doc_bison).dvi: $(FIGS_GV:.gv=.eps)
  27 $(doc_bison).info: $(FIGS_GV:.gv=.txt)
  28 $(doc_bison).pdf: $(FIGS_GV:.gv=.pdf)
  29 $(doc_bison).html: $(FIGS_GV:.gv=.png)
  30
  31 TEXI2DVI = texi2dvi --build-dir=doc/bison.t2d -I doc
  32 CLEANDIRS = doc/bison.t2d
  33 clean-local:
  34         rm -rf $(CLEANDIRS)
  35
  36 MOSTLYCLEANFILES += $(top_srcdir)/doc/*.t
  37
  38 CROSS_OPTIONS_PL = $(top_srcdir)/build-aux/cross-options.pl
  39 CROSS_OPTIONS_TEXI = $(top_srcdir)/doc/cross-options.texi
  40 $(CROSS_OPTIONS_TEXI): doc/bison.help $(CROSS_OPTIONS_PL)
  41 # Create $@~ which is the previous contents.  Don't use 'mv' here so
  42 # that even if we are interrupted, the file is still available for
  43 # diff in the next run.  Note that $@ might not exist yet.
  44         $(AM_V_GEN){ test ! -f $@ || cat $@; } >$@~
  45         $(AM_V_at)test ! -f $@.tmp || rm -f $@.tmp
  46         $(AM_V_at)src/bison$(EXEEXT) --help |                            \
  47           $(PERL) $(CROSS_OPTIONS_PL) $(top_srcdir)/src/scan-gram.l >$@.tmp
  48         $(AM_V_at)diff -u $@~ $@.tmp || true
  49         $(AM_V_at)mv $@.tmp $@
  50 MAINTAINERCLEANFILES = $(CROSS_OPTIONS_TEXI)
  51
  52 ## ---------- ##
  53 ## Ref card.  ##
  54 ## ---------- ##
  55
  56 EXTRA_DIST += doc/refcard.tex
  57 CLEANFILES += doc/refcard.pdf
  58
  59 doc/refcard.pdf: doc/refcard.tex
  60         $(AM_V_GEN) cd doc && pdftex $(abs_top_srcdir)/doc/refcard.tex
  61
  62
  63
  64 ## ---------------- ##
  65 ## doc/bison.help.  ##
  66 ## ---------------- ##
  67
  68 # Some of our targets (cross-option.texi, bison.1) use "bison --help".
  69 # Since we want to ship the generated file to avoid additional
  70 # requirements over the user environment, we used not depend on
  71 # src/bison itself, but on src/getargs.c and other files.  Yet, we
  72 # need "bison --help" to work to make help2man happy, so we used to
  73 # include "make src/bison" in the commands.  Then we may have a
  74 # problem with concurrent builds, since one make might be aiming one
  75 # of its jobs at compiling src/bison, and another job at generating
  76 # the man page.  If the latter is faster than the former, then we have
  77 # two makes that concurrently try to compile src/bison.  Doomed to
  78 # failure.
  79 #
  80 # As a simple scheme to get our way out, make a stamp file,
  81 # bison.help, which contains --version then --help.  This file can
  82 # depend on bison, which ensures its correctness.  But update it
  83 # *only* if needed (content changes).  This way, we avoid useless
  84 # compilations of cross-option.texi and bison.1.  At the cost of
  85 # repeated builds of bison.help.
  86
  87 EXTRA_DIST += $(top_srcdir)/doc/bison.help
  88 MAINTAINERCLEANFILES += $(top_srcdir)/doc/bison.help
  89 $(top_srcdir)/doc/bison.help: src/bison$(EXEEXT)
  90         $(AM_V_GEN)src/bison$(EXEEXT) --version >doc/bison.help.tmp
  91         $(AM_V_at) src/bison$(EXEEXT) --help   >>doc/bison.help.tmp
  92         $(AM_V_at)$(top_srcdir)/build-aux/move-if-change doc/bison.help.tmp $@
  93
  94
  95 ## ----------- ##
  96 ## Man Pages.  ##
  97 ## ----------- ##
  98
  99 dist_man_MANS = $(top_srcdir)/doc/bison.1
 100
 101 EXTRA_DIST += $(dist_man_MANS:.1=.x)
 102 MAINTAINERCLEANFILES += $(dist_man_MANS)
 103
 104 # Differences to ignore when comparing the man page (the date).
 105 remove_time_stamp = \
 106   sed 's/^\(\.TH[^"]*"[^"]*"[^"]*\)"[^"]*"/\1/'
 107
 108 # Depend on configure to get version number changes.
 109 $(top_srcdir)/doc/bison.1: doc/bison.help doc/bison.x $(top_srcdir)/configure
 110         $(AM_V_GEN)$(HELP2MAN)                  \
 111             --include=$(top_srcdir)/doc/bison.x \
 112             --output=$@.t src/bison$(EXEEXT)
 113         $(AM_V_at)if $(remove_time_stamp) $@ >$@a.t 2>/dev/null &&       \
 114            $(remove_time_stamp) $@.t | cmp $@a.t - >/dev/null 2>&1; then \
 115           touch $@;                                                      \
 116         else                                                             \
 117           mv $@.t $@;                                                    \
 118         fi
 119         $(AM_V_at)rm -f $@*.t
 120
 121 nodist_man_MANS = doc/yacc.1
 122
 123 ## ----------------------------- ##
 124 ## Graphviz examples generation. ##
 125 ## ----------------------------- ##
 126
 127 CLEANDIRS += doc/figs
 128 FIGS_GV =                                               \
 129   doc/figs/example.gv                                   \
 130   doc/figs/example-reduce.gv doc/figs/example-shift.gv
 131 EXTRA_DIST +=                                                   \
 132   $(FIGS_GV) $(FIGS_GV:.gv=.txt)                                \
 133   $(FIGS_GV:.gv=.eps) $(FIGS_GV:.gv=.pdf) $(FIGS_GV:.gv=.png)
 134 SUFFIXES += .gv .eps .pdf .png
 135
 136 .gv.eps:
 137         $(AM_V_GEN) $(MKDIR_P) `echo "./$@" | sed -e 's,/[^/]*$$,,'`
 138         $(AM_V_at) $(DOT) -Gmargin=0 -Teps $< >$@.tmp
 139         $(AM_V_at) mv $@.tmp $@
 140
 141 .gv.pdf:
 142         $(AM_V_GEN) $(MKDIR_P) `echo "./$@" | sed -e 's,/[^/]*$$,,'`
 143         $(AM_V_at) $(DOT) -Gmargin=0 -Tpdf $< >$@.tmp
 144         $(AM_V_at) mv $@.tmp $@
 145
 146 .gv.png:
 147         $(AM_V_GEN) $(MKDIR_P) `echo "./$@" | sed -e 's,/[^/]*$$,,'`
 148         $(AM_V_at) $(DOT) -Gmargin=0 -Tpng $< >$@.tmp
 149         $(AM_V_at) mv $@.tmp $@
 150
 151 ## -------------- ##
 152 ## Doxygenation.  ##
 153 ## -------------- ##
 154
 155 DOXYGEN = doxygen
 156
 157 .PHONY: doc html
 158
 159 doc: html
 160
 161 html-local: doc/Doxyfile
 162         $(AM_V_GEN) $(DOXYGEN) doc/Doxyfile
 163
 164 edit = sed -e 's,@PACKAGE_NAME\@,$(PACKAGE_NAME),g' \
 165            -e 's,@PACKAGE_VERSION\@,$(PACKAGE_VERSION),g' \
 166            -e 's,@PERL\@,$(PERL),g' \
 167            -e 's,@top_builddir\@,$(top_builddir),g' \
 168            -e 's,@top_srcdir\@,$(top_srcdir),g'
 169
 170 EXTRA_DIST += doc/Doxyfile.in
 171 CLEANFILES += doc/Doxyfile
 172 # Sed is used to generate Doxyfile from Doxyfile.in instead of
 173 # configure, because the former is way faster than the latter.
 174 doc/Doxyfile: $(top_srcdir)/doc/Doxyfile.in
 175         $(AM_V_GEN) $(edit) $(top_srcdir)/doc/Doxyfile.in >doc/Doxyfile
 176
 177 CLEANDIRS += doc/html