-##Copyright (C) 1991 Free Software Foundation, Inc.
+##Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1999, 2000, 2002
+##Free Software Foundation, Inc.
# Makefile for GDB documentation.
# This file is part of GDB.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-srcdir = .
+srcdir = @srcdir@
+VPATH = @srcdir@
-ddestdir = /usr/local
-idestdir = $(ddestdir)
+prefix = @prefix@
-SHELL = /bin/sh
+infodir = @infodir@
+htmldir = $(prefix)/html
-# main GDB source directory
-gdbdir = ..
+SHELL = @SHELL@
+
+LN_S = @LN_S@
-# Documentation (gdb.dvi) needs either GNU m4 or SysV m4;
-# Berkeley/Sun don't have quite enough.
-#M4=/usr/5bin/m4
-M4=gm4
+INSTALL = @INSTALL@
+INSTALL_PROGRAM = @INSTALL_PROGRAM@
+INSTALL_DATA = @INSTALL_DATA@
+
+# main GDB source directory
+gdbdir = $(srcdir)/..
# where to find texinfo; GDB dist should include a recent one
-TEXIDIR=${gdbdir}/../texinfo/fsf
+TEXIDIR=${gdbdir}/../texinfo
# where to find makeinfo, preferably one designed for texinfo-2
MAKEINFO=makeinfo
-# Where is the source dir for the READLINE library? Traditionally in .. or .
-# (For the binary library built from it, we use ${READLINE_DIR}${subdir}.)
-READLINE_DIR = ${gdbdir}/../readline
+# Note that texinfo 4.0's makeinfo --html can only generate a
+# single file, which would be too large, so continue to use
+# texi2html. -sts 2000-03-28
+
+MAKEHTML = texi2html
+MAKEHTMLFLAGS = -menu -split_chapter
+
+# where to find texi2roff, ditto
+TEXI2ROFF=texi2roff
+
+# where to find texi2dvi, ditto
+TEXI2DVI=texi2dvi
+
+# Where is the source dir for the READLINE library doc?
+# Traditionally readline is in .. or .
+READLINE_DIR = ${gdbdir}/../readline/doc
+
+# The GDB/MI docs come from a sibling directory ../mi
+GDBMI_DIR = ${gdbdir}/mi
+
+SET_TEXINPUTS = \
+ TEXINPUTS=${TEXIDIR}:.:$(srcdir):$(READLINE_DIR):$(GDBMI_DIR):$$TEXINPUTS
+
+# Files which should be generated via 'info' and installed by 'install-info'
+INFO_DEPS = gdb.info gdbint.info stabs.info
+
+# There may be alternate predefined collections of switches to configure
+# the GDB manual. Normally this is not done in synch with the software
+# config system, since this choice tends to be independent; most people
+# want a doc config of `all' for a generic manual, regardless of sw config.
+DOC_CONFIG = all
+
+# This list of sed edits will edit the GDB reference card
+# for what fonts and what papersize to use.
+# By default (NO edits applied), the refcard uses:
+# - Computer Modern (CM) fonts
+# - US letter paper (8.5x11in)
+# List some of the following files for alternative fonts and paper:
+# a4rc.sed use A4 paper (297 x 210 mm)
+# psrc.sed use PostScript fonts (Karl Berry short TeX names)
+# lpsrc.sed use PostScript fonts (full PostScript names in TeX)
+# e.g. for A4, Postscript: REFEDITS = a4rc.sed psrc.sed
+# for A4, CM fonts: REFEDITS = a4rc.sed
+# for US, PS fonts: REFEDITS = psrc.sed
+# for default:
+REFEDITS =
+
+# Don Knuth's TeX formatter
+TEX = tex
+
+# Program to generate Postscript files from DVI files.
+DVIPS = dvips
+
+# Main GDB manual
+GDB_DOC_SOURCE_INCLUDES = \
+ $(srcdir)/annotate.texi \
+ $(srcdir)/fdl.texi \
+ $(srcdir)/gpl.texi \
+ $(GDBMI_DIR)/gdbmi.texinfo \
+ $(READLINE_DIR)/rluser.texinfo \
+ $(READLINE_DIR)/inc-hist.texinfo
+GDB_DOC_BUILD_INCLUDES = \
+ gdb-cfg.texi \
+ GDBvn.texi
+GDB_DOC_FILES = \
+ $(srcdir)/gdb.texinfo \
+ $(GDB_DOC_SOURCE_INCLUDES) \
+ $(GDB_DOC_BUILD_INCLUDES)
+
+# Internals Manual
+GDBINT_DOC_SOURCE_INCLUDES = \
+ $(srcdir)/fdl.texi
+GDBINT_DOC_BUILD_INCLUDES = \
+ gdb-cfg.texi \
+ GDBvn.texi
+GDBINT_DOC_FILES = \
+ $(srcdir)/gdbint.texinfo \
+ $(GDBINT_DOC_SOURCE_INCLUDES) \
+ $(GDBINT_DOC_BUILD_INCLUDES)
-# Main GDB manual's source files
-SFILES_DOCDIR = \
- gdb.texinfo pretex.m4 none.m4 all.m4 gdbinv-m.m4 gdbinv-s.m4 gdbVN.m4
+# Stabs manual: All files
+STABS_DOC_SOURCE_INCLUDES =
+STABS_DOC_BUILD_INCLUDES =
+STABS_DOC_FILES = \
+ $(srcdir)/stabs.texinfo \
+ $(STABS_DOC_SOURCE_INCLUDES) \
+ $(STABS_DOC_BUILD_INCLUDES)
-all: gdb.info gdbint.info
-#all: gdb.info gdb.dvi refcard.dvi gdb-internals gdbint.dvi
+#### Host, target, and site specific Makefile fragments come in here.
+###
-install: force
- for i in *.info* ; do \
- echo Installing $$i... ; \
- (cp $$i $(idestdir)/info/$$i.new \
- && mv -f $(idestdir)/info/$$i.new $(idestdir)/info/$$i) \
- || exit 1 ; \
+all install:
+
+info: $(INFO_DEPS)
+dvi: gdb.dvi gdbint.dvi stabs.dvi refcard.dvi
+ps: gdb.ps gdbint.ps stabs.ps refcard.ps
+html: gdb_toc.html gdbint_toc.html stabs_toc.html
+pdf: gdb.pdf gdbint.pdf stabs.pdf
+all-doc: info dvi ps # pdf
+diststuff: info
+
+install-info: $(INFO_DEPS)
+ $(SHELL) $(srcdir)/../../mkinstalldirs $(infodir)
+ @list='$(INFO_DEPS)'; \
+ for file in $$list; do \
+ if test -f $$file; then d=.; else d=$(srcdir); fi; \
+ for ifile in `cd $$d && echo $$file $$file-[0-9] $$file-[0-9][0-9]`; do \
+ if test -f $$d/$$ifile; then \
+ echo " $(INSTALL_DATA) $$d/$$ifile $(infodir)/$$ifile"; \
+ $(INSTALL_DATA) $$d/$$ifile $(infodir)/$$ifile; \
+ else : ; fi; \
+ done; \
+ done
+ @if $(SHELL) -c 'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev/null 2>&1; then \
+ list='$(INFO_DEPS)'; \
+ for file in $$list; do \
+ echo " install-info --info-dir=$(infodir) $(infodir)/$$file";\
+ install-info --info-dir=$(infodir) $(infodir)/$$file || :;\
+ done; \
+ else : ; fi
+
+install-html: html
+ for i in *.html ; do \
+ $(INSTALL_DATA) $$i $(htmldir)/$$i ; \
+ done
+
+STAGESTUFF = *.info* gdb-all.texi GDBvn.texi *.ps *.dvi *.pdf
+
+# Copy the object files from a particular stage into a subdirectory.
+stage1: force
+ -mkdir stage1
+ -mv $(STAGESTUFF) stage1
+
+stage2: force
+ -mkdir stage2
+ -mv $(STAGESTUFF) stage2
+
+stage3: force
+ -mkdir stage3
+ -mv $(STAGESTUFF) stage3
+
+against=stage2
+
+comparison: force
+ for i in $(STAGESTUFF) ; do cmp $$i $(against)/$$i ; done
+
+de-stage1: force
+ -(cd stage1 ; mv -f * ..)
+ -rmdir stage1
+
+de-stage2: force
+ -(cd stage2 ; mv -f * ..)
+ -rmdir stage2
+
+de-stage3: force
+ -(cd stage3 ; mv -f * ..)
+ -rmdir stage3
+
+# GDB QUICK REFERENCE (dvi output)
+refcard.dvi : refcard.tex $(REFEDITS)
+ echo > tmp.sed
+ for f in x $(REFEDITS) ; do \
+ test x$$f = xx && continue ; \
+ cat $(srcdir)/$$f >>tmp.sed ; \
done
+ sed -f tmp.sed $(srcdir)/refcard.tex >sedref.tex
+ $(SET_TEXINPUTS) $(TEX) sedref.tex
+ mv sedref.dvi refcard.dvi
+ rm -f sedref.log sedref.tex tmp.sed
+
+refcard.ps : refcard.dvi
+ $(DVIPS) -t landscape -o $@ $?
-clean:
- rm -f gdb.dvi rdl-apps.texi gdb-all* gdb.info* gdbVN.m4
- rm -f gdb-internals gdbint.?? gdbint.??? gdbint.info
- rm -f refcard.ps refcard.dvi rcfonts.tex refcard.log *~
-
-# GDB QUICK REFERENCE (TeX dvi file, CM fonts)
-refcard.dvi : refcard.tex
- rm -f rcfonts.tex; cp rc-cm.tex rcfonts.tex
- TEXINPUTS=.:$$TEXINPUTS tex refcard.tex; rm -f refcard.log
- rm -f rcfonts.tex
-
-# GDB QUICK REFERENCE (PostScript output, common PS fonts)
-refcard.ps : refcard.tex
- rm -f rcfonts.tex; cp rc-ps.tex rcfonts.tex
- TEXINPUTS=.:$$TEXINPUTS tex refcard.tex
- dvips -t landscape refcard -o; rm -f refcard.dvi refcard.log
- rm -f rcfonts.tex
-
-# Cover file for "Readline" appendices
-rdl-apps.texi: ${READLINE_DIR}/inc-readline.texinfo \
- ${READLINE_DIR}/inc-history.texinfo
- rm -f rdl-apps.texi
- echo "@include ${READLINE_DIR}/inc-readline.texinfo" >rdl-apps.texi
- echo "@include ${READLINE_DIR}/inc-history.texinfo" >>rdl-apps.texi
-
-# File to record current GDB version number (copied from main dir Makefile.in)
-gdbVN.m4 : ${gdbdir}/Makefile.in
- ( VER=`sed <${gdbdir}/Makefile.in -n 's/VERSION = //p'` ;\
- echo "_define__(<_GDB_VN__>,$$VER)" > gdbVN.m4 )
-
-# GDB MANUAL: texinfo source, created by preprocessing w/m4
-# Be sure to not create a bad gdb-all.texi if ${M4} is missing or aborts...
-gdb-all.texi: ${SFILES_DOCDIR}
- rm -f foobus.texinfo
- ${M4} pretex.m4 none.m4 all.m4 gdb.texinfo >foobus.texinfo
- rm -f gdb-all.texi
- mv foobus.texinfo gdb-all.texi
+# File to record current GDB version number (copied from main dir version.in)
+GDBvn.texi : ${gdbdir}/version.in
+ echo "@set GDBVN `head -1 $(srcdir)/../version.in`" > ./GDBvn.new
+ mv GDBvn.new GDBvn.texi
+
+# Updated atomically
+.PRECIOUS: GDBvn.texi
+
+# Choose configuration for GDB manual (normally `all'; normally not tied into
+# `configure' script because most users prefer generic version of manual,
+# not one for their binary config---which may not be specifically
+# defined anyways).
+gdb-cfg.texi: ${srcdir}/${DOC_CONFIG}-cfg.texi
+ (test "$$LN_S" = "ln -s" && \
+ ln -s ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi) || \
+ ln ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
+ cp ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
+
+# GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear
+# If your texinfo or makeinfo don't support these, get a new texinfo release
+#
+# The nonsense with GDBvn.texi gets this to run with both Sun and GNU make.
+# Note that we can *generate* GDBvn.texi, but since we distribute one in the
+# source directory for the benefit of people who *don't* use this makefile,
+# VPATH will often tell make not to bother building it, because the one
+# in the srcdir is up to date. (if not, then make should build one here).
+
+# Clean these up before each run. Avoids a catch 22 with not being
+# able to re-generate these files (to fix a corruption) because these
+# files contain a corruption.
+GDB_TEX_TMPS = gdb.aux gdb.cp* gdb.fn* gdb.ky* gdb.log gdb.pg* gdb.toc \
+ gdb.tp* gdb.vr*
# GDB MANUAL: TeX dvi file
-gdb.dvi : gdb-all.texi rdl-apps.texi
- TEXINPUTS=${TEXIDIR}:.:$$TEXINPUTS tex gdb-all.texi
- texindex gdb-all.??
- TEXINPUTS=${TEXIDIR}:.:$$TEXINPUTS tex gdb-all.texi
- mv gdb-all.dvi gdb.dvi
- rm -f gdb-all.?? gdb-all.???
+gdb.dvi: ${GDB_DOC_FILES}
+ if [ ! -f ./GDBvn.texi ]; then \
+ (test "$$LN_S" = "ln -s" && ln -s $(srcdir)/GDBvn.texi .) || \
+ ln $(srcdir)/GDBvn.texi . || \
+ cp $(srcdir)/GDBvn.texi . ; else true; fi
+ rm -f $(GDB_TEX_TMPS)
+ $(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/gdb.texinfo
+
+gdb.ps: gdb.dvi
+ $(DVIPS) -o $@ $?
+
+gdb.pdf: ${GDB_DOC_FILES}
+ if [ ! -f ./GDBvn.texi ]; then \
+ (test "$$LN_S" = "ln -s" && ln -s $(srcdir)/GDBvn.texi .) || \
+ ln $(srcdir)/GDBvn.texi . || \
+ cp $(srcdir)/GDBvn.texi . ; else true; fi
+ rm -f $(GDB_TEX_TMPS)
+ $(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/gdb.texinfo
# GDB MANUAL: info file
-# We're using texinfo2, and older makeinfo's may not be able to
-# cope with all the markup. In the meantime, we distribute the info
-# files
-gdb.info: gdb-all.texi
- $(MAKEINFO) -o gdb.info $(srcdir)/gdb-all.texi
+gdb.info: ${GDB_DOC_FILES}
+ $(MAKEINFO) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) \
+ -o gdb.info $(srcdir)/gdb.texinfo
+
+# GDB MANUAL: roff translations
+# Try to use a recent texi2roff. v2 was put on prep in jan91.
+# If you want an index, see texi2roff doc for postprocessing
+# and add -i to texi2roff invocations below.
+# Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete
+# corresponding -e lines when later texi2roff's are current)
+# + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs.
+# + @c's deleted explicitly because texi2roff sees texinfo commands in them
+# + @ (that's at-BLANK) not recognized by texi2roff, turned into blank
+# + @alphaenumerate is ridiculously new, turned into @enumerate
+
+# texi2roff doesn't have a notion of include dirs, so we have to fake
+# it out for gdb manual's include files---but only if not configured
+# in main sourcedir.
+links2roff: $(GDB_DOC_SOURCE_INCLUDES)
+ if [ ! -f gdb.texinfo ]; then \
+ (test "$$LN_S" = "ln -s" && ln -s $(GDB_DOC_SOURCE_INCLUDES) .) || \
+ ln $(GDB_DOC_SOURCE_INCLUDES) . || \
+ cp $(GDB_DOC_SOURCE_INCLUDES) . ; \
+ fi
+ touch links2roff
+
+# gdb manual suitable for [gtn]roff -me
+gdb.me: $(GDB_DOC_FILES) links2roff
+ sed -e '/\\input texinfo/d' \
+ -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
+ -e '/^@ifinfo/,/^@end ifinfo/d' \
+ -e '/^@c /d' \
+ -e 's/{.*,,/{/' \
+ -e 's/@ / /g' \
+ -e 's/^@alphaenumerate/@enumerate/g' \
+ -e 's/^@end alphaenumerate/@end enumerate/g' \
+ $(srcdir)/gdb.texinfo | \
+ $(TEXI2ROFF) -me | \
+ sed -e 's/---/\\(em/g' \
+ >gdb.me
+
+# gdb manual suitable for [gtn]roff -ms
+gdb.ms: $(GDB_DOC_FILES) links2roff
+ sed -e '/\\input texinfo/d' \
+ -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
+ -e '/^@ifinfo/,/^@end ifinfo/d' \
+ -e '/^@c /d' \
+ -e 's/{.*,,/{/' \
+ -e 's/@ / /g' \
+ -e 's/^@alphaenumerate/@enumerate/g' \
+ -e 's/^@end alphaenumerate/@end enumerate/g' \
+ $(srcdir)/gdb.texinfo | \
+ $(TEXI2ROFF) -ms | \
+ sed -e 's/---/\\(em/g' \
+ >gdb.ms
+
+# gdb manual suitable for [tn]roff -mm
+# '@noindent's removed due to texi2roff-2 mm bug; if yours is newer,
+# try leaving them in
+gdb.mm: $(GDB_DOC_FILES) links2roff
+ sed -e '/\\input texinfo/d' \
+ -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
+ -e '/^@ifinfo/,/^@end ifinfo/d' \
+ -e '/^@c /d' \
+ -e 's/{.*,,/{/' \
+ -e '/@noindent/d' \
+ -e 's/@ / /g' \
+ -e 's/^@alphaenumerate/@enumerate/g' \
+ -e 's/^@end alphaenumerate/@end enumerate/g' \
+ $(srcdir)/gdb.texinfo | \
+ $(TEXI2ROFF) -mm | \
+ sed -e 's/---/\\(em/g' \
+ >gdb.mm
+
+# GDB MANUAL: HTML file
+
+gdb_toc.html: ${GDB_DOC_FILES}
+ $(MAKEHTML) $(MAKEHTMLFLAGS) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) $(srcdir)/gdb.texinfo
+
+# Clean these up before each run. Avoids a catch 22 with not being
+# able to re-generate these files (to fix a corruption) because these
+# files contain a corruption.
+GDBINT_TEX_TMPS = gdbint.aux gdbint.cp* gdbint.fn* gdbint.ky* \
+ gdbint.log gdbint.pg* gdbint.toc gdbint.tp* gdbint.vr*
# GDB INTERNALS MANUAL: TeX dvi file
-gdbint.dvi : gdbint.texinfo
- TEXINPUTS=${TEXIDIR}:.:$$TEXINPUTS tex gdbint.texinfo
- texindex gdbint.??
- TEXINPUTS=${TEXIDIR}:.:$$TEXINPUTS tex gdbint.texinfo
- rm -f gdbint.?? gdbint.aux gdbint.cps gdbint.fns gdbint.kys \
- gdbint.log gdbint.pgs gdbint.toc gdbint.tps gdbint.vrs
+gdbint.dvi: $(GDBINT_DOC_FILES)
+ rm -f $(GDBINT_TEX_TMPS)
+ $(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/gdbint.texinfo
+
+gdbint.ps : gdbint.dvi
+ $(DVIPS) -o $@ $?
+
+gdbint.pdf: $(GDBINT_DOC_FILES)
+ rm -f $(GDBINT_TEX_TMPS)
+ $(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/gdbint.texinfo
# GDB INTERNALS MANUAL: info file
-gdb-internals: gdbint.info
-gdbint.info: gdbint.texinfo
- $(MAKEINFO) -o gdbint.info $(srcdir)/gdbint.texinfo
+gdbint.info: $(GDBINT_DOC_FILES)
+ $(MAKEINFO) -I $(srcdir) -o gdbint.info $(srcdir)/gdbint.texinfo
+
+# GDB INTERNALS MANUAL: HTML file
+
+gdbint_toc.html: $(GDBINT_DOC_FILES)
+ $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/gdbint.texinfo
+
+stabs.info: $(STABS_DOC_FILES)
+ $(MAKEINFO) -o stabs.info $(srcdir)/stabs.texinfo
+
+# STABS DOCUMENTATION: HTML file
+
+stabs_toc.html: $(STABS_DOC_FILES)
+ $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/stabs.texinfo
+
+# Clean these up before each run. Avoids a catch 22 with not being
+# able to re-generate these files (to fix a corruption) because these
+# files contain a corruption.
+STABS_TEX_TMPS = stabs.aux stabs.cp* stabs.fn* stabs.ky* \
+ stabs.log stabs.pg* stabs.toc stabs.tp* stabs.vr*
+
+# STABS DOCUMENTATION: TeX dvi file
+stabs.dvi : $(STABS_DOC_FILES)
+ rm -f $(STABS_TEX_TMPS)
+ $(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/stabs.texinfo
+
+stabs.ps: stabs.dvi
+ $(DVIPS) -o $@ $?
+
+stabs.pdf: $(STABS_DOC_FILES)
+ rm -f $(STABS_TEX_TMPS)
+ $(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/stabs.texinfo
force:
-Makefile: $(srcdir)/Makefile.in $(host_makefile_frag) $(target_makefile_frag)
+Makefile: Makefile.in $(host_makefile_frag) $(target_makefile_frag) config.status
$(SHELL) ./config.status
+
+
+# The "least clean" level of cleaning. Get rid of files which are
+# automatically generated files that are just intermediate files,
+
+mostlyclean:
+ rm -f gdb.mm gdb.ms gdb.me links2roff
+ rm -f $(GDB_TEX_TMPS)
+ rm -f $(GDBINT_TEX_TMPS)
+ rm -f $(STABS_TEX_TMPS)
+ rm -f sedref.dvi sedref.tex tmp.sed
+
+clean: mostlyclean
+ rm -f gdb-cfg.texi
+
+distclean: clean
+ rm -f Makefile config.status
+
+# GDBvn.texi, the dvi files, the info files, and the postscript files,
+# are all part of the distribution, so it should not be removed by
+# "clean" or "distclean". Use maintainer-clean to remove them.
+
+maintainer-clean realclean: distclean
+ rm -f GDBvn.texi *.info* *.dvi *.ps *.html *.pdf
+
projects / deliverable / binutils-gdb.git / blobdiff