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