doc/local.mk

   1 ## Copyright (C) 2001-2003, 2005-2011 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.texinfo
  18 doc_bison_TEXINFOS =                            \
  19   $(CROSS_OPTIONS_TEXI)                         \
  20   doc/fdl.texi                                  \
  21   doc/gpl-3.0.texi
  22
  23 CLEANFILES = doc/bison.fns
  24 CLEANDIRS = doc/*.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         { test ! -f $@ || cat $@; } >$@~
  37         test ! -f $@.tmp || rm -f $@.tmp
  38         src/bison$(EXEEXT) --help |                                      \
  39           perl $(CROSS_OPTIONS_PL) $(top_srcdir)/src/scan-gram.l >$@.tmp
  40         diff -u $@~ $@.tmp || true
  41         mv $@.tmp $@
  42 MAINTAINERCLEANFILES = $(CROSS_OPTIONS_TEXI)
  43
  44 ## ---------- ##
  45 ## Ref card.  ##
  46 ## ---------- ##
  47
  48 EXTRA_DIST += doc/refcard.tex
  49 CLEANFILES += doc/refcard.dvi doc/refcard.log doc/refcard.ps
  50
  51 doc/refcard.dvi: doc/refcard.tex
  52         cd doc && tex refcard.tex
  53
  54 doc/refcard.ps: doc/refcard.dvi
  55
  56
  57 ## ---------------- ##
  58 ## doc/bison.help.  ##
  59 ## ---------------- ##
  60
  61 # Some of our targets (cross-option.texi, bison.1) use "bison --help".
  62 # Since we want to ship the generated file to avoid additional
  63 # requirements over the user environment, we used not depend on
  64 # src/bison itself, but on src/getargs.c and other files.  Yet, we
  65 # need "bison --help" to work to make help2man happy, so we used to
  66 # include "make src/bison" in the commands.  Then we may have a
  67 # problem with concurrent builds, since one make might be aiming one
  68 # of its jobs at compiling src/bison, and another job at generating
  69 # the man page.  If the latter is faster than the former, then we have
  70 # two makes that concurrently try to compile src/bison.  Doomed to
  71 # failure.
  72 #
  73 # As a simple scheme to get our way out, make a stamp file,
  74 # bison.help, which contains --version then --help.  This file can
  75 # depend on bison, which ensures its correctness.  But update it
  76 # *only* if needed (content changes).  This way, we avoid useless
  77 # compilations of cross-option.texi and bison.1.  At the cost of
  78 # repeated builds of bison.help.
  79
  80 EXTRA_DIST += $(top_srcdir)/doc/bison.help
  81 MAINTAINERCLEANFILES += $(top_srcdir)/doc/bison.help
  82 $(top_srcdir)/doc/bison.help: src/bison$(EXEEXT)
  83         $< --version >doc/bison.help.t
  84         $< --help   >>doc/bison.help.t
  85         $(top_srcdir)/build-aux/move-if-change doc/bison.help.t $@
  86
  87
  88 ## ----------- ##
  89 ## Man Pages.  ##
  90 ## ----------- ##
  91
  92 dist_man_MANS = $(top_srcdir)/doc/bison.1
  93
  94 EXTRA_DIST += $(dist_man_MANS:.1=.x)
  95 MAINTAINERCLEANFILES += $(dist_man_MANS)
  96
  97 # Differences to ignore when comparing the man page (the date).
  98 remove_time_stamp = \
  99   sed 's/^\(\.TH[^"]*"[^"]*"[^"]*\)"[^"]*"/\1/'
 100
 101 # Depend on configure to get version number changes.
 102 $(top_srcdir)/doc/bison.1: doc/bison.help doc/bison.x $(top_srcdir)/configure
 103         @echo "Updating man page $@"
 104         $(HELP2MAN)                                     \
 105             --include=$(top_srcdir)/doc/bison.x         \
 106             --output=$@.t src/bison$(EXEEXT)
 107         if $(remove_time_stamp) $@ >$@a.t 2>/dev/null &&                 \
 108            $(remove_time_stamp) $@.t | cmp $@a.t - >/dev/null 2>&1; then \
 109           touch $@;                                                      \
 110         else                                                             \
 111           mv $@.t $@;                                                    \
 112         fi
 113         rm -f $@*.t
 114
 115 nodist_man_MANS = doc/yacc.1
 116
 117 ## -------------- ##
 118 ## Doxygenation.  ##
 119 ## -------------- ##
 120
 121 DOXYGEN = doxygen
 122
 123 .PHONY: doc html
 124
 125 doc: html
 126
 127 html-local: doc/Doxyfile
 128         cd doc && $(DOXYGEN)
 129
 130 edit = sed -e 's,@PACKAGE_NAME\@,$(PACKAGE_NAME),g' \
 131            -e 's,@PACKAGE_VERSION\@,$(PACKAGE_VERSION),g' \
 132            -e 's,@top_builddir\@,$(top_builddir),g' \
 133            -e 's,@top_srcdir\@,$(top_srcdir),g'
 134
 135 EXTRA_DIST += doc/Doxyfile.in
 136 CLEANFILES += doc/Doxyfile
 137 # Sed is used to generate Doxyfile from Doxyfile.in instead of
 138 # configure, because the former is way faster than the latter.
 139 doc/Doxyfile: $(top_srcdir)/doc/Doxyfile.in
 140         $(edit) $(top_srcdir)/doc/Doxyfile.in >doc/Doxyfile
 141
 142 CLEANDIRS += html latex