gdb/doc/Makefile.in

   1 ##Copyright (C) 1991, 1992, 1999 Free Software Foundation, Inc.
   2
   3 # Makefile for GDB documentation.
   4 # This file is part of GDB.
   5
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19
  20 srcdir = @srcdir@
  21 VPATH = @srcdir@
  22
  23 prefix = @prefix@
  24
  25 infodir = @infodir@
  26 htmldir = $(prefix)/html
  27
  28 SHELL = @SHELL@
  29
  30 INSTALL = @INSTALL@
  31 INSTALL_PROGRAM = @INSTALL_PROGRAM@
  32 INSTALL_DATA = @INSTALL_DATA@
  33
  34 # main GDB source directory
  35 gdbdir = $(srcdir)/..
  36
  37 # where to find texinfo; GDB dist should include a recent one
  38 TEXIDIR=${gdbdir}/../texinfo
  39
  40 # where to find makeinfo, preferably one designed for texinfo-2
  41 MAKEINFO=makeinfo
  42
  43 MAKEHTML = texi2html
  44 MAKEHTMLFLAGS = -glossary -menu -split_chapter
  45
  46 # where to find texi2roff, ditto
  47 TEXI2ROFF=texi2roff
  48
  49 # Where is the source dir for the READLINE library doc?
  50 # Traditionally readline is in .. or .
  51 READLINE_DIR = ${gdbdir}/../readline/doc
  52
  53 SET_TEXINPUTS = TEXINPUTS=${TEXIDIR}:.:$(srcdir):$(READLINE_DIR):$$TEXINPUTS
  54
  55 # There may be alternate predefined collections of switches to configure
  56 # the GDB manual.  Normally this is not done in synch with the software
  57 # config system, since this choice tends to be independent; most people
  58 # want a doc config of `all' for a generic manual, regardless of sw config.
  59 DOC_CONFIG = all
  60
  61 # This list of sed edits will edit the GDB reference card
  62 # for what fonts and what papersize to use.
  63 # By default (NO edits applied), the refcard uses:
  64 #    - Computer Modern (CM) fonts
  65 #    - US letter paper (8.5x11in)
  66 # List some of the following files for alternative fonts and paper:
  67 #  a4rc.sed     use A4 paper (297 x 210 mm)
  68 #  psrc.sed     use PostScript fonts (Karl Berry short TeX names)
  69 # lpsrc.sed     use PostScript fonts (full PostScript names in TeX)
  70 # e.g. for A4, Postscript:  REFEDITS = a4rc.sed psrc.sed
  71 #      for A4, CM fonts:    REFEDITS = a4rc.sed
  72 #      for US, PS fonts:    REFEDITS = psrc.sed
  73 #      for default:
  74 REFEDITS =
  75
  76 # Don Knuth's TeX formatter
  77 TEX = tex
  78
  79 # auxiliary program for sorting Texinfo indices
  80 TEXINDEX = texindex
  81
  82 # Program to generate Postscript files from DVI files.
  83 DVIPS = dvips
  84
  85 # Main GDB manual's source files
  86 SFILES_INCLUDED = gdb-cfg.texi
  87
  88 SFILES_LOCAL = $(srcdir)/gdb.texinfo GDBvn.texi $(SFILES_INCLUDED)
  89
  90 SFILES_DOC = $(SFILES_LOCAL) \
  91                 $(READLINE_DIR)/rluser.texinfo $(READLINE_DIR)/inc-hist.texinfo
  92
  93 #### Host, target, and site specific Makefile fragments come in here.
  94 ###
  95
  96 all install:
  97
  98 info: gdb.info gdbint.info stabs.info
  99 dvi: gdb.dvi gdbint.dvi stabs.dvi refcard.dvi
 100 ps: gdb.ps gdbint.ps stabs.ps refcard.ps
 101 html: gdb_toc.html gdbint_toc.html stabs_toc.html
 102 all-doc: info dvi ps
 103 diststuff: info
 104
 105 install-info: info
 106         for i in *.info* ; do \
 107                 $(INSTALL_DATA) $$i $(infodir)/$$i ; \
 108         done
 109
 110 install-html: html
 111         for i in *.html ; do \
 112                 $(INSTALL_DATA) $$i $(htmldir)/$$i ; \
 113         done
 114
 115 STAGESTUFF = *.info* gdb-all.texi GDBvn.texi *.ps *.dvi
 116
 117 # Copy the object files from a particular stage into a subdirectory.
 118 stage1: force
 119         -mkdir stage1
 120         -mv $(STAGESTUFF) stage1
 121
 122 stage2: force
 123         -mkdir stage2
 124         -mv $(STAGESTUFF) stage2
 125
 126 stage3: force
 127         -mkdir stage3
 128         -mv $(STAGESTUFF) stage3
 129
 130 against=stage2
 131
 132 comparison: force
 133         for i in $(STAGESTUFF) ; do cmp $$i $(against)/$$i ; done
 134
 135 de-stage1: force
 136         -(cd stage1 ; mv -f * ..)
 137         -rmdir stage1
 138
 139 de-stage2: force
 140         -(cd stage2 ; mv -f * ..)
 141         -rmdir stage2
 142
 143 de-stage3: force
 144         -(cd stage3 ; mv -f * ..)
 145         -rmdir stage3
 146
 147 # The "least clean" level of cleaning.  Get rid of files which are
 148 # automatically generated files that are just intermediate files,
 149 #
 150 mostlyclean:
 151         rm -f gdb.mm gdb.ms gdb.me links2roff
 152         rm -f *.aux *.cp* *.fn* *.ky* *.log *.pg* *.toc *.tp* *.vr*
 153         rm -f sedref.dvi sedref.tex tmp.sed
 154
 155 clean: mostlyclean
 156         rm -f rluser.texinfo inc-hist.texinfo gdb-cfg.texi
 157
 158 distclean: clean
 159         rm -f Makefile config.status
 160
 161 # GDBvn.texi, the dvi files, the info files, and the postscript files,
 162 # are all part of the distribution, so it should not be removed by
 163 # "clean" or "distclean".  Use maintainer-clean to remove them.
 164
 165 maintainer-clean realclean: distclean
 166         rm -f GDBvn.texi *.info* *.dvi *.ps *.html
 167
 168 # GDB QUICK REFERENCE (dvi output)
 169 refcard.dvi : refcard.tex $(REFEDITS)
 170         if [ -z "$(REFEDITS)" ]; then \
 171                 cp $(srcdir)/refcard.tex sedref.tex ; \
 172         else \
 173                 echo > tmp.sed ; \
 174                 for f in "$(REFEDITS)" ; do \
 175                         cat $(srcdir)/$$f >>tmp.sed ; done ; \
 176                 sed -f tmp.sed $(srcdir)/refcard.tex >sedref.tex ; \
 177         fi
 178         $(SET_TEXINPUTS) $(TEX) sedref.tex
 179         mv sedref.dvi refcard.dvi
 180         rm -f sedref.log sedref.tex tmp.sed
 181
 182 refcard.ps : refcard.dvi
 183         $(DVIPS) -t landscape -o $@ $?
 184
 185 # File to record current GDB version number (copied from main dir Makefile.in)
 186 GDBvn.texi : ${gdbdir}/Makefile.in
 187         echo "@set GDBVN `sed <$(srcdir)/../Makefile.in -n 's/^VERSION *= *//p'`" > ./GDBvn.new
 188         mv GDBvn.new GDBvn.texi
 189
 190 # Updated atomically
 191 .PRECIOUS: GDBvn.texi
 192
 193 # Choose configuration for GDB manual (normally `all'; normally not tied into
 194 # `configure' script because most users prefer generic version of manual,
 195 # not one for their binary config---which may not be specifically
 196 # defined anyways).
 197 gdb-cfg.texi: ${srcdir}/${DOC_CONFIG}-cfg.texi
 198         ln -s ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
 199         ln ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
 200         cp ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
 201
 202 # GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear
 203 # If your texinfo or makeinfo don't support these, get a new texinfo release
 204 #
 205 # The nonsense with GDBvn.texi gets this to run with both Sun and GNU make.
 206 #   Note that we can *generate* GDBvn.texi, but since we distribute one in the
 207 #   source directory for the benefit of people who *don't* use this makefile,
 208 #   VPATH will often tell make not to bother building it, because the one
 209 #   in the srcdir is up to date.  (if not, then make should build one here).
 210
 211 # GDB MANUAL: TeX dvi file
 212 gdb.dvi: ${SFILES_DOC}
 213         if [ ! -f ./GDBvn.texi ]; then \
 214                 ln -s $(srcdir)/GDBvn.texi . || \
 215                 ln $(srcdir)/GDBvn.texi . || \
 216                 cp $(srcdir)/GDBvn.texi . ; else true; fi
 217         $(SET_TEXINPUTS) $(TEX) gdb.texinfo
 218         $(SET_TEXINPUTS) $(TEX) gdb.texinfo
 219         $(TEXINDEX) gdb.??
 220         $(SET_TEXINPUTS) $(TEX) gdb.texinfo
 221         rm -f gdb.aux gdb.cp* gdb.fn* gdb.ky* gdb.log gdb.pg* gdb.toc \
 222                 gdb.tp* gdb.vr*
 223
 224 gdb.ps: gdb.dvi
 225         $(DVIPS) -o $@ $?
 226
 227 # GDB MANUAL: info file
 228 # We're using texinfo2, and older makeinfo's may not be able to
 229 # cope with all the markup.
 230 gdb.info: ${SFILES_DOC}
 231         $(MAKEINFO) -I ${READLINE_DIR} -I $(srcdir) -o ./gdb.info gdb.texinfo
 232
 233 # GDB MANUAL: roff translations
 234 # Try to use a recent texi2roff.  v2 was put on prep in jan91.
 235 # If you want an index, see texi2roff doc for postprocessing
 236 # and add -i to texi2roff invocations below.
 237 # Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete
 238 #    corresponding -e lines when later texi2roff's are current)
 239 # + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs.
 240 # + @c's deleted explicitly because texi2roff sees texinfo commands in them
 241 # + @   (that's at-BLANK) not recognized by texi2roff, turned into blank
 242 # + @alphaenumerate is ridiculously new, turned into @enumerate
 243
 244 # texi2roff doesn't have a notion of include dirs, so we have to fake
 245 # it out for gdb manual's include files---but only if not configured
 246 # in main sourcedir.
 247 links2roff: $(SFILES_INCLUDED)
 248         if [ ! -f gdb.texinfo ]; then \
 249                 ln -s $(SFILES_INCLUDED) . || \
 250                 ln $(SFILES_INCLUDED)    . || \
 251                 cp $(SFILES_INCLUDED)    . ; \
 252         fi
 253         touch links2roff
 254
 255 #  "Readline" appendices.  Get them also due to lack of includes,
 256 # regardless of whether or not configuring in main sourcedir.
 257 # @ftable removed due to bug in texi2roff-2; if your texi2roff
 258 # is newer, try just ln or cp
 259 rluser.texinfo: ${READLINE_DIR}/rluser.texinfo
 260                 sed -e 's/^@ftable/@table/g' \
 261                 -e 's/^@end ftable/@end table/g' \
 262                 ${READLINE_DIR}/rluser.texinfo > ./rluser.texinfo
 263
 264 inc-hist.texinfo: ${READLINE_DIR}/inc-hist.texinfo
 265         ln -s ${READLINE_DIR}/inc-hist.texinfo . || \
 266         ln ${READLINE_DIR}/inc-hist.texinfo . || \
 267         cp ${READLINE_DIR}/inc-hist.texinfo .
 268
 269 # gdb manual suitable for [gtn]roff -me
 270 gdb.me: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texinfo
 271         sed -e '/\\input texinfo/d' \
 272                 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
 273                 -e '/^@ifinfo/,/^@end ifinfo/d' \
 274                 -e '/^@c /d' \
 275                 -e 's/{.*,,/{/' \
 276                 -e 's/@ / /g' \
 277                 -e 's/^@alphaenumerate/@enumerate/g' \
 278                 -e 's/^@end alphaenumerate/@end enumerate/g' \
 279                 $(srcdir)/gdb.texinfo | \
 280         $(TEXI2ROFF) -me | \
 281         sed -e 's/---/\\(em/g' \
 282         >gdb.me
 283
 284 # gdb manual suitable for [gtn]roff -ms
 285 gdb.ms: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texinfo
 286         sed -e '/\\input texinfo/d' \
 287                 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
 288                 -e '/^@ifinfo/,/^@end ifinfo/d' \
 289                 -e '/^@c /d' \
 290                 -e 's/{.*,,/{/' \
 291                 -e 's/@ / /g' \
 292                 -e 's/^@alphaenumerate/@enumerate/g' \
 293                 -e 's/^@end alphaenumerate/@end enumerate/g' \
 294                 $(srcdir)/gdb.texinfo | \
 295         $(TEXI2ROFF) -ms | \
 296         sed -e 's/---/\\(em/g' \
 297         >gdb.ms
 298
 299 # gdb manual suitable for [tn]roff -mm
 300 # '@noindent's removed due to texi2roff-2 mm bug; if yours is newer,
 301 #   try leaving them in
 302 gdb.mm: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texinfo
 303         sed -e '/\\input texinfo/d' \
 304                 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
 305                 -e '/^@ifinfo/,/^@end ifinfo/d' \
 306                 -e '/^@c /d' \
 307                 -e 's/{.*,,/{/' \
 308                 -e '/@noindent/d' \
 309                 -e 's/@ / /g' \
 310                 -e 's/^@alphaenumerate/@enumerate/g' \
 311                 -e 's/^@end alphaenumerate/@end enumerate/g' \
 312                 $(srcdir)/gdb.texinfo | \
 313         $(TEXI2ROFF) -mm | \
 314         sed -e 's/---/\\(em/g' \
 315         >gdb.mm
 316
 317 # GDB MANUAL: HTML file
 318
 319 gdb_toc.html: ${SFILES_DOC}
 320         $(MAKEHTML) $(MAKEHTMLFLAGS) -I ${READLINE_DIR} -I $(srcdir) $(srcdir)/gdb.texinfo
 321
 322 # GDB GUI MANUAL: TeX dvi file
 323 gdbgui.dvi : gdbgui.texinfo ${SFILES_DOC}
 324         $(SET_TEXINPUTS) $(TEX) gdbgui.texinfo
 325         $(TEXINDEX) gdbgui.??
 326         $(SET_TEXINPUTS) $(TEX) gdbgui.texinfo
 327         rm -f gdbgui.aux gdbgui.cp* gdbgui.fn* gdbgui.ky* \
 328                 gdbgui.log gdbgui.pg* gdbgui.toc gdbgui.tp* gdbgui.vr*
 329
 330 # GDB GUI MANUAL: info file
 331 gdb-gui: gdbgui.info
 332
 333 gdbgui.info: gdbgui.texinfo ${SFILES_DOC}
 334         $(MAKEINFO) -o gdbgui.info $(srcdir)/gdbgui.texinfo
 335
 336 # GDB INTERNALS MANUAL: TeX dvi file
 337 gdbint.dvi : gdbint.texinfo
 338         $(SET_TEXINPUTS) $(TEX) gdbint.texinfo
 339         $(TEXINDEX) gdbint.??
 340         $(SET_TEXINPUTS) $(TEX) gdbint.texinfo
 341         rm -f gdbint.aux gdbint.cp* gdbint.fn* gdbint.ky* \
 342                 gdbint.log gdbint.pg* gdbint.toc gdbint.tp* gdbint.vr*
 343
 344 gdbint.ps : gdbint.dvi
 345         $(DVIPS) -o $@ $?
 346
 347 # GDB INTERNALS MANUAL: info file
 348
 349 gdbint.info: gdbint.texinfo
 350         $(MAKEINFO) -o gdbint.info $(srcdir)/gdbint.texinfo
 351
 352 # GDB INTERNALS MANUAL: HTML file
 353
 354 gdbint_toc.html: gdbint.texinfo
 355         $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/gdbint.texinfo
 356
 357 stabs.info: stabs.texinfo
 358         $(MAKEINFO) -o stabs.info $(srcdir)/stabs.texinfo
 359
 360 # STABS DOCUMENTATION: HTML file
 361
 362 stabs_toc.html: stabs.texinfo
 363         $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/stabs.texinfo
 364
 365 # STABS DOCUMENTATION: TeX dvi file
 366 stabs.dvi : stabs.texinfo
 367         $(SET_TEXINPUTS) $(TEX) stabs.texinfo
 368         $(TEXINDEX) stabs.??
 369         $(SET_TEXINPUTS) $(TEX) stabs.texinfo
 370         rm -f stabs.aux stabs.cp* stabs.fn* stabs.ky* \
 371                 stabs.log stabs.pg* stabs.toc stabs.tp* stabs.vr*
 372
 373 stabs.ps: stabs.dvi
 374         $(DVIPS) -o $@ $?
 375
 376 force:
 377
 378 Makefile: Makefile.in $(host_makefile_frag) $(target_makefile_frag) config.status
 379         $(SHELL) ./config.status