1##Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1999, 2000, 2002, 2003 2##Free Software Foundation, Inc. 3 4# Makefile for GDB documentation. 5# This file is part of GDB. 6 7# This program is free software; you can redistribute it and/or modify 8# it under the terms of the GNU General Public License as published by 9# the Free Software Foundation; either version 2 of the License, or 10# (at your option) any later version. 11# 12# This program is distributed in the hope that it will be useful, 13# but WITHOUT ANY WARRANTY; without even the implied warranty of 14# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15# GNU General Public License for more details. 16# 17# You should have received a copy of the GNU General Public License 18# along with this program; if not, write to the Free Software 19# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 20 21srcdir = @srcdir@ 22VPATH = @srcdir@ 23 24prefix = @prefix@ 25 26infodir = @infodir@ 27htmldir = $(prefix)/html 28 29SHELL = @SHELL@ 30 31LN_S = @LN_S@ 32 33INSTALL = @INSTALL@ 34INSTALL_PROGRAM = @INSTALL_PROGRAM@ 35INSTALL_DATA = @INSTALL_DATA@ 36 37# main GDB source directory 38gdbdir = $(srcdir)/.. 39 40# where to find texinfo; GDB dist should include a recent one 41TEXIDIR=${gdbdir}/../texinfo 42 43# where to find makeinfo, preferably one designed for texinfo-2 44MAKEINFO=makeinfo 45 46# Note that texinfo 4.0's makeinfo --html can only generate a 47# single file, which would be too large, so continue to use 48# texi2html. -sts 2000-03-28 49 50MAKEHTML = texi2html 51MAKEHTMLFLAGS = -menu -split_chapter 52 53# where to find texi2roff, ditto 54TEXI2ROFF=texi2roff 55 56# where to find texi2dvi, ditto 57TEXI2DVI=texi2dvi 58 59# Where is the source dir for the READLINE library doc? 60# Traditionally readline is in .. or . 61READLINE_DIR = ${gdbdir}/../readline/doc 62 63# The GDB/MI docs come from a sibling directory ../mi 64GDBMI_DIR = ${gdbdir}/mi 65 66SET_TEXINPUTS = \ 67 TEXINPUTS=${TEXIDIR}:.:$(srcdir):$(READLINE_DIR):$(GDBMI_DIR):$$TEXINPUTS 68 69# Files which should be generated via 'info' and installed by 'install-info' 70INFO_DEPS = gdb.info gdbint.info stabs.info annotate.info 71 72# There may be alternate predefined collections of switches to configure 73# the GDB manual. Normally this is not done in synch with the software 74# config system, since this choice tends to be independent; most people 75# want a doc config of `all' for a generic manual, regardless of sw config. 76DOC_CONFIG = all 77 78# This list of sed edits will edit the GDB reference card 79# for what fonts and what papersize to use. 80# By default (NO edits applied), the refcard uses: 81# - Computer Modern (CM) fonts 82# - US letter paper (8.5x11in) 83# List some of the following files for alternative fonts and paper: 84# a4rc.sed use A4 paper (297 x 210 mm) 85# psrc.sed use PostScript fonts (Karl Berry short TeX names) 86# lpsrc.sed use PostScript fonts (full PostScript names in TeX) 87# e.g. for A4, Postscript: REFEDITS = a4rc.sed psrc.sed 88# for A4, CM fonts: REFEDITS = a4rc.sed 89# for US, PS fonts: REFEDITS = psrc.sed 90# for default: 91REFEDITS = 92 93# Don Knuth's TeX formatter 94TEX = tex 95 96# Program to generate Postscript files from DVI files. 97DVIPS = dvips 98 99# Main GDB manual 100GDB_DOC_SOURCE_INCLUDES = \ 101 $(srcdir)/fdl.texi \ 102 $(srcdir)/gpl.texi \ 103 $(srcdir)/agentexpr.texi \ 104 $(READLINE_DIR)/rluser.texinfo \ 105 $(READLINE_DIR)/inc-hist.texinfo 106GDB_DOC_BUILD_INCLUDES = \ 107 gdb-cfg.texi \ 108 GDBvn.texi 109GDB_DOC_FILES = \ 110 $(srcdir)/gdb.texinfo \ 111 $(GDB_DOC_SOURCE_INCLUDES) \ 112 $(GDB_DOC_BUILD_INCLUDES) 113 114# Internals Manual 115GDBINT_DOC_SOURCE_INCLUDES = \ 116 $(srcdir)/fdl.texi \ 117 $(srcdir)/observer.texi 118GDBINT_DOC_BUILD_INCLUDES = \ 119 gdb-cfg.texi \ 120 GDBvn.texi 121GDBINT_DOC_FILES = \ 122 $(srcdir)/gdbint.texinfo \ 123 $(GDBINT_DOC_SOURCE_INCLUDES) \ 124 $(GDBINT_DOC_BUILD_INCLUDES) 125 126# Stabs manual: All files 127STABS_DOC_SOURCE_INCLUDES = \ 128 $(srcdir)/fdl.texi 129STABS_DOC_BUILD_INCLUDES = 130STABS_DOC_FILES = \ 131 $(srcdir)/stabs.texinfo \ 132 $(STABS_DOC_SOURCE_INCLUDES) \ 133 $(STABS_DOC_BUILD_INCLUDES) 134 135# Annotate migration document 136ANNOTATE_DOC_SOURCE_INCLUDES = \ 137 $(srcdir)/fdl.texi 138ANNOTATE_DOC_BUILD_INCLUDES = \ 139 gdb-cfg.texi 140ANNOTATE_DOC_FILES = \ 141 $(srcdir)/annotate.texinfo \ 142 $(ANNOTATE_DOC_SOURCE_INCLUDES) \ 143 $(ANNOTATE_DOC_BUILD_INCLUDES) 144 145#### Host, target, and site specific Makefile fragments come in here. 146### 147 148all: 149 150info: $(INFO_DEPS) 151dvi: gdb.dvi gdbint.dvi stabs.dvi refcard.dvi annotate.dvi 152ps: gdb.ps gdbint.ps stabs.ps refcard.ps annotate.ps 153html: gdb_toc.html gdbint_toc.html stabs_toc.html annotate_toc.html 154pdf: gdb.pdf gdbint.pdf stabs.pdf annotate.pdf 155all-doc: info dvi ps # pdf 156diststuff: info 157 158install-info: $(INFO_DEPS) 159 $(SHELL) $(srcdir)/../../mkinstalldirs $(DESTDIR)$(infodir) 160 @list='$(INFO_DEPS)'; \ 161 for file in $$list; do \ 162 if test -f $$file; then d=.; else d=$(srcdir); fi; \ 163 for ifile in `cd $$d && echo $$file $$file-[0-9] $$file-[0-9][0-9]`; do \ 164 if test -f $$d/$$ifile; then \ 165 echo " $(INSTALL_DATA) $$d/$$ifile $(DESTDIR)$(infodir)/$$ifile"; \ 166 $(INSTALL_DATA) $$d/$$ifile $(DESTDIR)$(infodir)/$$ifile; \ 167 else : ; fi; \ 168 done; \ 169 done 170 $(POST_INSTALL) 171 @if $(SHELL) -c 'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev/null 2>&1; then \ 172 list='$(INFO_DEPS)'; \ 173 for file in $$list; do \ 174 echo " install-info --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/$$file";\ 175 install-info --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/$$file || :;\ 176 done; \ 177 else : ; fi 178 179uninstall-info: 180 $(PRE_UNINSTALL) 181 @if $(SHELL) -c 'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev/null 2>&1; then \ 182 ii=yes; \ 183 else ii=; fi; \ 184 list='$(INFO_DEPS)'; \ 185 for file in $$list; do \ 186 test -z "$$ii" \ 187 || install-info --info-dir=$(DESTDIR)$(infodir) --remove $$file; \ 188 done 189 $(NORMAL_UNINSTALL) 190 list='$(INFO_DEPS)'; \ 191 for file in $$list; do \ 192 (cd $(DESTDIR)$(infodir) && rm -f $$file $$file-[0-9] $$file-[0-9][0-9]); \ 193 done 194 195install-html: html 196 for i in *.html ; do \ 197 $(INSTALL_DATA) $$i $(DESTDIR)$(htmldir)/$$i ; \ 198 done 199 200STAGESTUFF = *.info* gdb-all.texi GDBvn.texi *.ps *.dvi *.pdf 201 202# Copy the object files from a particular stage into a subdirectory. 203stage1: force 204 -mkdir stage1 205 -mv $(STAGESTUFF) stage1 206 207stage2: force 208 -mkdir stage2 209 -mv $(STAGESTUFF) stage2 210 211stage3: force 212 -mkdir stage3 213 -mv $(STAGESTUFF) stage3 214 215against=stage2 216 217comparison: force 218 for i in $(STAGESTUFF) ; do cmp $$i $(against)/$$i ; done 219 220de-stage1: force 221 -(cd stage1 ; mv -f * ..) 222 -rmdir stage1 223 224de-stage2: force 225 -(cd stage2 ; mv -f * ..) 226 -rmdir stage2 227 228de-stage3: force 229 -(cd stage3 ; mv -f * ..) 230 -rmdir stage3 231 232# GDB QUICK REFERENCE (dvi output) 233refcard.dvi : refcard.tex $(REFEDITS) 234 echo > tmp.sed 235 for f in x $(REFEDITS) ; do \ 236 test x$$f = xx && continue ; \ 237 cat $(srcdir)/$$f >>tmp.sed ; \ 238 done 239 sed -f tmp.sed $(srcdir)/refcard.tex >sedref.tex 240 $(SET_TEXINPUTS) $(TEX) sedref.tex 241 mv sedref.dvi refcard.dvi 242 rm -f sedref.log sedref.tex tmp.sed 243 244refcard.ps : refcard.dvi 245 $(DVIPS) -t landscape -o $@ $? 246 247# File to record current GDB version number (copied from main dir version.in) 248GDBvn.texi : ${gdbdir}/version.in 249 echo "@set GDBVN `sed q $(srcdir)/../version.in`" > ./GDBvn.new 250 mv GDBvn.new GDBvn.texi 251 252# Updated atomically 253.PRECIOUS: GDBvn.texi 254 255# Choose configuration for GDB manual (normally `all'; normally not tied into 256# `configure' script because most users prefer generic version of manual, 257# not one for their binary config---which may not be specifically 258# defined anyways). 259gdb-cfg.texi: ${srcdir}/${DOC_CONFIG}-cfg.texi 260 (test "$(LN_S)" = "ln -s" && \ 261 ln -s ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi) || \ 262 ln ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \ 263 cp ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi 264 265# GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear 266# If your texinfo or makeinfo don't support these, get a new texinfo release 267# 268# The nonsense with GDBvn.texi gets this to run with both Sun and GNU make. 269# Note that we can *generate* GDBvn.texi, but since we distribute one in the 270# source directory for the benefit of people who *don't* use this makefile, 271# VPATH will often tell make not to bother building it, because the one 272# in the srcdir is up to date. (if not, then make should build one here). 273 274# Clean these up before each run. Avoids a catch 22 with not being 275# able to re-generate these files (to fix a corruption) because these 276# files contain a corruption. 277GDB_TEX_TMPS = gdb.aux gdb.cp* gdb.fn* gdb.ky* gdb.log gdb.pg* gdb.toc \ 278 gdb.tp* gdb.vr* 279 280# GDB MANUAL: TeX dvi file 281gdb.dvi: ${GDB_DOC_FILES} 282 if [ ! -f ./GDBvn.texi ]; then \ 283 (test "$(LN_S)" = "ln -s" && ln -s $(srcdir)/GDBvn.texi .) || \ 284 ln $(srcdir)/GDBvn.texi . || \ 285 cp $(srcdir)/GDBvn.texi . ; else true; fi 286 rm -f $(GDB_TEX_TMPS) 287 $(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/gdb.texinfo 288 289gdb.ps: gdb.dvi 290 $(DVIPS) -o $@ $? 291 292gdb.pdf: ${GDB_DOC_FILES} 293 if [ ! -f ./GDBvn.texi ]; then \ 294 (test "$(LN_S)" = "ln -s" && ln -s $(srcdir)/GDBvn.texi .) || \ 295 ln $(srcdir)/GDBvn.texi . || \ 296 cp $(srcdir)/GDBvn.texi . ; else true; fi 297 rm -f $(GDB_TEX_TMPS) 298 $(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/gdb.texinfo 299 300# GDB MANUAL: info file 301gdb.info: ${GDB_DOC_FILES} 302 $(MAKEINFO) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) \ 303 -o gdb.info $(srcdir)/gdb.texinfo 304 305# GDB MANUAL: roff translations 306# Try to use a recent texi2roff. v2 was put on prep in jan91. 307# If you want an index, see texi2roff doc for postprocessing 308# and add -i to texi2roff invocations below. 309# Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete 310# corresponding -e lines when later texi2roff's are current) 311# + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs. 312# + @c's deleted explicitly because texi2roff sees texinfo commands in them 313# + @ (that's at-BLANK) not recognized by texi2roff, turned into blank 314# + @alphaenumerate is ridiculously new, turned into @enumerate 315 316# texi2roff doesn't have a notion of include dirs, so we have to fake 317# it out for gdb manual's include files---but only if not configured 318# in main sourcedir. 319links2roff: $(GDB_DOC_SOURCE_INCLUDES) 320 if [ ! -f gdb.texinfo ]; then \ 321 (test "$(LN_S)" = "ln -s" && ln -s $(GDB_DOC_SOURCE_INCLUDES) .) || \ 322 ln $(GDB_DOC_SOURCE_INCLUDES) . || \ 323 cp $(GDB_DOC_SOURCE_INCLUDES) . ; \ 324 fi 325 touch links2roff 326 327# gdb manual suitable for [gtn]roff -me 328gdb.me: $(GDB_DOC_FILES) links2roff 329 sed -e '/\\input texinfo/d' \ 330 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \ 331 -e '/^@ifinfo/,/^@end ifinfo/d' \ 332 -e '/^@c /d' \ 333 -e 's/{.*,,/{/' \ 334 -e 's/@ / /g' \ 335 -e 's/^@alphaenumerate/@enumerate/g' \ 336 -e 's/^@end alphaenumerate/@end enumerate/g' \ 337 $(srcdir)/gdb.texinfo | \ 338 $(TEXI2ROFF) -me | \ 339 sed -e 's/---/\\(em/g' \ 340 >gdb.me 341 342# gdb manual suitable for [gtn]roff -ms 343gdb.ms: $(GDB_DOC_FILES) links2roff 344 sed -e '/\\input texinfo/d' \ 345 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \ 346 -e '/^@ifinfo/,/^@end ifinfo/d' \ 347 -e '/^@c /d' \ 348 -e 's/{.*,,/{/' \ 349 -e 's/@ / /g' \ 350 -e 's/^@alphaenumerate/@enumerate/g' \ 351 -e 's/^@end alphaenumerate/@end enumerate/g' \ 352 $(srcdir)/gdb.texinfo | \ 353 $(TEXI2ROFF) -ms | \ 354 sed -e 's/---/\\(em/g' \ 355 >gdb.ms 356 357# gdb manual suitable for [tn]roff -mm 358# '@noindent's removed due to texi2roff-2 mm bug; if yours is newer, 359# try leaving them in 360gdb.mm: $(GDB_DOC_FILES) links2roff 361 sed -e '/\\input texinfo/d' \ 362 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \ 363 -e '/^@ifinfo/,/^@end ifinfo/d' \ 364 -e '/^@c /d' \ 365 -e 's/{.*,,/{/' \ 366 -e '/@noindent/d' \ 367 -e 's/@ / /g' \ 368 -e 's/^@alphaenumerate/@enumerate/g' \ 369 -e 's/^@end alphaenumerate/@end enumerate/g' \ 370 $(srcdir)/gdb.texinfo | \ 371 $(TEXI2ROFF) -mm | \ 372 sed -e 's/---/\\(em/g' \ 373 >gdb.mm 374 375# GDB MANUAL: HTML file 376 377gdb_toc.html: ${GDB_DOC_FILES} 378 $(MAKEHTML) $(MAKEHTMLFLAGS) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) $(srcdir)/gdb.texinfo 379 380# Clean these up before each run. Avoids a catch 22 with not being 381# able to re-generate these files (to fix a corruption) because these 382# files contain a corruption. 383GDBINT_TEX_TMPS = gdbint.aux gdbint.cp* gdbint.fn* gdbint.ky* \ 384 gdbint.log gdbint.pg* gdbint.toc gdbint.tp* gdbint.vr* 385 386# GDB INTERNALS MANUAL: TeX dvi file 387gdbint.dvi: $(GDBINT_DOC_FILES) 388 rm -f $(GDBINT_TEX_TMPS) 389 $(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/gdbint.texinfo 390 391gdbint.ps : gdbint.dvi 392 $(DVIPS) -o $@ $? 393 394gdbint.pdf: $(GDBINT_DOC_FILES) 395 rm -f $(GDBINT_TEX_TMPS) 396 $(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/gdbint.texinfo 397 398# GDB INTERNALS MANUAL: info file 399 400gdbint.info: $(GDBINT_DOC_FILES) 401 $(MAKEINFO) -I $(srcdir) -o gdbint.info $(srcdir)/gdbint.texinfo 402 403# GDB INTERNALS MANUAL: HTML file 404 405gdbint_toc.html: $(GDBINT_DOC_FILES) 406 $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/gdbint.texinfo 407 408stabs.info: $(STABS_DOC_FILES) 409 $(MAKEINFO) -I $(srcdir) -o stabs.info $(srcdir)/stabs.texinfo 410 411# STABS DOCUMENTATION: HTML file 412 413stabs_toc.html: $(STABS_DOC_FILES) 414 $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/stabs.texinfo 415 416# Clean these up before each run. Avoids a catch 22 with not being 417# able to re-generate these files (to fix a corruption) because these 418# files contain a corruption. 419STABS_TEX_TMPS = stabs.aux stabs.cp* stabs.fn* stabs.ky* \ 420 stabs.log stabs.pg* stabs.toc stabs.tp* stabs.vr* 421 422# STABS DOCUMENTATION: TeX dvi file 423stabs.dvi : $(STABS_DOC_FILES) 424 rm -f $(STABS_TEX_TMPS) 425 $(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/stabs.texinfo 426 427stabs.ps: stabs.dvi 428 $(DVIPS) -o $@ $? 429 430stabs.pdf: $(STABS_DOC_FILES) 431 rm -f $(STABS_TEX_TMPS) 432 $(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/stabs.texinfo 433 434# Clean these up before each run. Avoids a catch 22 with not being 435# able to re-generate these files (to fix a corruption) because these 436# files contain a corruption. 437ANNOTATE_TEX_TMPS = annotate.aux annotate.cp* annotate.fn* annotate.ky* \ 438 annotate.log annotate.pg* annotate.toc annotate.tp* annotate.vr* 439 440# ANNOTATE DOCUMENTATION: TeX dvi file 441annotate.dvi : $(ANNOTATE_DOC_FILES) 442 rm -f $(ANNOTATE_TEX_TMPS) 443 $(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/annotate.texinfo 444 445annotate.ps: annotate.dvi 446 $(DVIPS) -o $@ $? 447 448annotate.pdf: $(ANNOTATE_DOC_FILES) 449 rm -f $(ANNOTATE_TEX_TMPS) 450 $(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/annotate.texinfo 451 452annotate.info: $(ANNOTATE_DOC_FILES) 453 $(MAKEINFO) -I $(srcdir) -o annotate.info $(srcdir)/annotate.texinfo 454 455annotate_toc.html: $(ANNOTATE_DOC_FILES) 456 $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/annotate.texinfo 457 458force: 459 460Makefile: Makefile.in $(host_makefile_frag) $(target_makefile_frag) config.status 461 $(SHELL) ./config.status 462 463 464# The "least clean" level of cleaning. Get rid of files which are 465# automatically generated files that are just intermediate files, 466 467mostlyclean: 468 rm -f gdb.mm gdb.ms gdb.me links2roff 469 rm -f $(GDB_TEX_TMPS) 470 rm -f $(GDBINT_TEX_TMPS) 471 rm -f $(STABS_TEX_TMPS) 472 rm -f $(ANNOTATE_TEX_TMPS) 473 rm -f sedref.dvi sedref.tex tmp.sed 474 475clean: mostlyclean 476 rm -f gdb-cfg.texi 477 478distclean: clean 479 rm -f Makefile config.status config.log 480 481# GDBvn.texi, the dvi files, the info files, and the postscript files, 482# are all part of the distribution, so it should not be removed by 483# "clean" or "distclean". Use maintainer-clean to remove them. 484 485maintainer-clean realclean: distclean 486 rm -f GDBvn.texi *.info* *.dvi *.ps *.html *.pdf 487 488install: install-info 489 490uninstall: uninstall-info 491