-##Copyright (C) 1991, 1992 Free Software Foundation, Inc.
+##Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1999, 2000
+##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@
-prefix = /usr/local
+prefix = @prefix@
-infodir = $(prefix)/info
+infodir = @infodir@
+htmldir = $(prefix)/html
-SHELL = /bin/sh
+SHELL = @SHELL@
-INSTALL = install -c
-INSTALL_PROGRAM = $(INSTALL)
-INSTALL_DATA = $(INSTALL)
+LN_S = @LN_S@
+
+INSTALL = @INSTALL@
+INSTALL_PROGRAM = @INSTALL_PROGRAM@
+INSTALL_DATA = @INSTALL_DATA@
# main GDB source directory
gdbdir = $(srcdir)/..
# where to find makeinfo, preferably one designed for texinfo-2
MAKEINFO=makeinfo
+# 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
# Traditionally readline is in .. or .
READLINE_DIR = ${gdbdir}/../readline/doc
-SET_TEXINPUTS = TEXINPUTS=${TEXIDIR}:.:$(srcdir):$(READLINE_DIR):$$TEXINPUTS
+# 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
# auxiliary program for sorting Texinfo indices
TEXINDEX = texindex
+# Program to generate Postscript files from DVI files.
+DVIPS = dvips
+
+# Program to generate PDF files from tex files.
+PDFTEX = pdftex
+
# Main GDB manual's source files
-SFILES_INCLUDED = gdb-config.texi $(srcdir)/gdbinv-s.texi
+SFILES_INCLUDED = gdb-cfg.texi $(srcdir)/annotate.texi
SFILES_LOCAL = $(srcdir)/gdb.texinfo GDBvn.texi $(SFILES_INCLUDED)
-SFILES_DOC = $(SFILES_LOCAL) \
- $(READLINE_DIR)/rluser.texinfo $(READLINE_DIR)/inc-hist.texi
+SFILES_DOC = $(SFILES_LOCAL) $(GDBMI_DIR)/gdbmi.texinfo \
+ $(READLINE_DIR)/rluser.texinfo $(READLINE_DIR)/inc-hist.texinfo
#### Host, target, and site specific Makefile fragments come in here.
###
all install:
-info: gdb.info gdbint.info stabs.info
-dvi: gdb.dvi refcard.dvi gdbint.dvi
-all-doc: gdb.info gdb.dvi refcard.dvi gdb-internals gdbint.dvi
-
-install-info: info
- -parent=`echo $(infodir)|sed -e 's@/[^/]*$$@@'`; \
- if [ -d $$parent ] ; then true ; else mkdir $$parent ; fi
- -if [ -d $(infodir) ] ; then true ; else mkdir $(infodir) ; fi
- for i in *.info* ; do \
- $(INSTALL_DATA) $$i $(infodir)/$$i ; \
+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
+STAGESTUFF = *.info* gdb-all.texi GDBvn.texi *.ps *.dvi *.pdf
# Copy the object files from a particular stage into a subdirectory.
stage1: force
-(cd stage3 ; mv -f * ..)
-rmdir stage3
-clean-info:
- rm -f gdb.info* gdbint.info* stabs.info*
-
-clean-dvi:
- rm -f gdb.dvi refcard.dvi gdbint.dvi stabs.dvi psref.dvi
-
-mostlyclean: clean-info clean-dvi
- rm -f gdb.?? gdb.??? gdb.mm gdb.ms gdb.me
- rm -f links2roff
- rm -f refcard.ps lrefcard.ps refcard.log psref.* *~
- rm -f gdbint.?? gdbint.??? stabs.?? stabs.???
+# 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 *.aux *.cp* *.fn* *.ky* *.log *.pg* *.toc *.tp* *.vr*
+ rm -f sedref.dvi sedref.tex tmp.sed
clean: mostlyclean
- rm -f GDBvn.texi rluser.texinfo inc-hist.texi
+ rm -f rluser.texinfo inc-hist.texinfo gdb-cfg.texi
distclean: clean
rm -f Makefile config.status
-realclean: distclean
+# 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
-# GDB QUICK REFERENCE (TeX dvi file, CM fonts)
-refcard.dvi : $(srcdir)/refcard.tex
- $(SET_TEXINPUTS) $(TEX) refcard.tex; rm -f refcard.log
- rm -f rcfonts.tex
+# 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
-# GDB QUICK REFERENCE (PostScript output, common PS fonts)
-refcard.ps : $(srcdir)/refcard.tex $(srcdir)/psrc.sed
- sed -f $(srcdir)/psrc.sed $(srcdir)/refcard.tex >psref.tex
- $(SET_TEXINPUTS) $(TEX) psref.tex
- dvips -t landscape psref -o; mv psref.ps refcard.ps
- rm -f psref.dvi psref.log psref.tex
+refcard.ps : refcard.dvi
+ $(DVIPS) -t landscape -o $@ $?
-# GDB QUICK REFERENCE (PostScript output, common PS fonts w/long names)
-lrefcard.ps : $(srcdir)/refcard.tex $(srcdir)/lpsrc.sed
- sed -f $(srcdir)/lpsrc.sed $(srcdir)/refcard.tex >psref.tex
- $(SET_TEXINPUTS) $(TEX) psref.tex
- dvips -t landscape psref -o; mv psref.ps lrefcard.ps
- rm -f psref.dvi psref.log psref.tex
+# 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
-# File to record current GDB version number (copied from main dir Makefile.in)
-GDBvn.texi : ${gdbdir}/Makefile.in
- echo "@set GDBVN `sed <$(srcdir)/../Makefile.in -n 's/VERSION = //p'`" > ./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-config.texi: ${srcdir}/${DOC_CONFIG}-config.texi
- ln -s ${srcdir}/${DOC_CONFIG}-config.texi gdb-config.texi || \
- ln ${srcdir}/${DOC_CONFIG}-config.texi gdb-config.texi || \
- cp ${srcdir}/${DOC_CONFIG}-config.texi gdb-config.texi
+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
# GDB MANUAL: TeX dvi file
gdb.dvi: ${SFILES_DOC}
if [ ! -f ./GDBvn.texi ]; then \
- ln -s $(srcdir)/GDBvn.texi . || \
+ (test "$$LN_S" = "ln -s" && ln -s $(srcdir)/GDBvn.texi .) || \
ln $(srcdir)/GDBvn.texi . || \
cp $(srcdir)/GDBvn.texi . ; else true; fi
$(SET_TEXINPUTS) $(TEX) gdb.texinfo
$(SET_TEXINPUTS) $(TEX) gdb.texinfo
$(TEXINDEX) gdb.??
$(SET_TEXINPUTS) $(TEX) gdb.texinfo
- rm -f gdb.?? gdb.log gdb.aux gdb.toc gdb.??s
+ rm -f gdb.aux gdb.cp* gdb.fn* gdb.ky* gdb.log gdb.pg* gdb.toc \
+ gdb.tp* gdb.vr*
+
+gdb.ps: gdb.dvi
+ $(DVIPS) -o $@ $?
+
+gdb.pdf: ${SFILES_DOC}
+ 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
+ $(SET_TEXINPUTS) $(PDFTEX) gdb.texinfo
+ $(SET_TEXINPUTS) $(PDFTEX) gdb.texinfo
+ $(TEXINDEX) gdb.??
+ $(SET_TEXINPUTS) $(PDFTEX) gdb.texinfo
+ rm -f gdb.aux gdb.cp* gdb.fn* gdb.ky* gdb.log gdb.pg* gdb.toc \
+ gdb.tp* gdb.vr*
# GDB MANUAL: info file
-# We're using texinfo2, and older makeinfo's may not be able to
+# We're using texinfo 3.12; older makeinfo's may not be able to
# cope with all the markup.
gdb.info: ${SFILES_DOC}
- $(MAKEINFO) -I ${READLINE_DIR} -I $(srcdir) -o ./gdb.info gdb.texinfo
+ $(MAKEINFO) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) -o ./gdb.info gdb.texinfo
# GDB MANUAL: roff translations
# Try to use a recent texi2roff. v2 was put on prep in jan91.
# in main sourcedir.
links2roff: $(SFILES_INCLUDED)
if [ ! -f gdb.texinfo ]; then \
- ln -s $(SFILES_INCLUDED) . || \
+ (test "$$LN_S" = "ln -s" && ln -s $(SFILES_INCLUDED) .) || \
ln $(SFILES_INCLUDED) . || \
cp $(SFILES_INCLUDED) . ; \
fi
-e 's/^@end ftable/@end table/g' \
${READLINE_DIR}/rluser.texinfo > ./rluser.texinfo
-inc-hist.texi: ${READLINE_DIR}/inc-hist.texi
- ln -s ${READLINE_DIR}/inc-hist.texi . || \
- ln ${READLINE_DIR}/inc-hist.texi . || \
- cp ${READLINE_DIR}/inc-hist.texi .
+inc-hist.texinfo: ${READLINE_DIR}/inc-hist.texinfo
+ (test "$$LN_S" = "ln -s" && \
+ ln -s ${READLINE_DIR}/inc-hist.texinfo .) || \
+ ln ${READLINE_DIR}/inc-hist.texinfo . || \
+ cp ${READLINE_DIR}/inc-hist.texinfo .
+
+gdbmi.texinfo: ${GDBMI_DIR}/gdbmi.texinfo
+ (test "$$LN_S" = "ln -s" && \
+ ln -s ${GDBMI_DIR}/gdbmi.texinfo .) || \
+ ln ${GDBMI_DIR}/gdbmi.texinfo . || \
+ cp ${GDBMI_DIR}/gdbmi.texinfo .
# gdb manual suitable for [gtn]roff -me
-gdb.me: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texi
+gdb.me: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texinfo gdbmi.texinfo
sed -e '/\\input texinfo/d' \
-e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
-e '/^@ifinfo/,/^@end ifinfo/d' \
>gdb.me
# gdb manual suitable for [gtn]roff -ms
-gdb.ms: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texi
+gdb.ms: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texinfo gdbmi.texinfo
sed -e '/\\input texinfo/d' \
-e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
-e '/^@ifinfo/,/^@end ifinfo/d' \
# 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: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texi
+gdb.mm: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texinfo gdbmi.texinfo
sed -e '/\\input texinfo/d' \
-e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
-e '/^@ifinfo/,/^@end ifinfo/d' \
sed -e 's/---/\\(em/g' \
>gdb.mm
+# GDB MANUAL: HTML file
+
+gdb_toc.html: ${SFILES_DOC}
+ $(MAKEHTML) $(MAKEHTMLFLAGS) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) $(srcdir)/gdb.texinfo
+
# GDB INTERNALS MANUAL: TeX dvi file
gdbint.dvi : gdbint.texinfo
$(SET_TEXINPUTS) $(TEX) gdbint.texinfo
$(TEXINDEX) gdbint.??
$(SET_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
+ rm -f gdbint.aux gdbint.cp* gdbint.fn* gdbint.ky* \
+ gdbint.log gdbint.pg* gdbint.toc gdbint.tp* gdbint.vr*
+
+gdbint.ps : gdbint.dvi
+ $(DVIPS) -o $@ $?
+
+gdbint.pdf: gdbint.dvi
+ $(SET_TEXINPUTS) $(PDFTEX) gdbint.texinfo
+ $(TEXINDEX) gdbint.??
+ $(SET_TEXINPUTS) $(PDFTEX) gdbint.texinfo
+ rm -f gdbint.aux gdbint.cp* gdbint.fn* gdbint.ky* \
+ gdbint.log gdbint.pg* gdbint.toc gdbint.tp* gdbint.vr*
# GDB INTERNALS MANUAL: info file
-gdb-internals: gdbint.info
gdbint.info: gdbint.texinfo
$(MAKEINFO) -o gdbint.info $(srcdir)/gdbint.texinfo
+# GDB INTERNALS MANUAL: HTML file
+
+gdbint_toc.html: gdbint.texinfo
+ $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/gdbint.texinfo
+
stabs.info: stabs.texinfo
$(MAKEINFO) -o stabs.info $(srcdir)/stabs.texinfo
+# STABS DOCUMENTATION: HTML file
+
+stabs_toc.html: stabs.texinfo
+ $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/stabs.texinfo
+
# STABS DOCUMENTATION: TeX dvi file
stabs.dvi : stabs.texinfo
$(SET_TEXINPUTS) $(TEX) stabs.texinfo
$(TEXINDEX) stabs.??
$(SET_TEXINPUTS) $(TEX) stabs.texinfo
- rm -f stabs.?? stabs.aux stabs.cps stabs.fns stabs.kys \
- stabs.log stabs.pgs stabs.toc stabs.tps stabs.vrs
+ rm -f stabs.aux stabs.cp* stabs.fn* stabs.ky* \
+ stabs.log stabs.pg* stabs.toc stabs.tp* stabs.vr*
stabs.ps: stabs.dvi
- dvips -o stabs.ps stabs
+ $(DVIPS) -o $@ $?
+
+stabs.pdf: stabs.dvi
+ $(SET_TEXINPUTS) $(PDFTEX) stabs.texinfo
+ $(TEXINDEX) stabs.??
+ $(SET_TEXINPUTS) $(PDFTEX) stabs.texinfo
+ rm -f stabs.aux stabs.cp* stabs.fn* stabs.ky* \
+ stabs.log stabs.pg* stabs.toc stabs.tp* stabs.vr*
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