aboutsummaryrefslogtreecommitdiff
path: root/gdb/doc
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2000-04-23 08:15:49 +0000
committerEli Zaretskii <eliz@gnu.org>2000-04-23 08:15:49 +0000
commit7162c0cabe922de558b7f88b975ce9e587c8b69c (patch)
treeb1daa2f1393ee961731b2e88d079f6b13d23823e /gdb/doc
parent878798ce4669299cdbccdc5b914799235b6d657d (diff)
downloadgdb-7162c0cabe922de558b7f88b975ce9e587c8b69c.zip
gdb-7162c0cabe922de558b7f88b975ce9e587c8b69c.tar.gz
gdb-7162c0cabe922de558b7f88b975ce9e587c8b69c.tar.bz2
* Makefile.in (GDBMI_DIR): New variable.
(SET_TEXINPUTS): Add $(GDBMI_DIR). (SFILES_DOC): Add $(GDBMI_DIR)/gdbmi.texinfo. (gdbmi.texinfo): New target, for texi2roff. (gdb.me, gdb.ms, gdb.mm): Depend on gdbmi.texinfo. (gdb.info, gdb_toc.html): Add "-I ${GDBMI_DIR}". * gdb.texinfo (Top): Add GDB/MI to the main menu and @include gdbmi.texinfo. (Mode Options): Add xref to GDB/MI docs and remove a FIXME comment. * gdbmi.texinfo: Lots of changes, to include this document as part of the GDB manual. * TODO, NEWS: Update due to inclusion of gdbmi.texinfo in the GDB manual.
Diffstat (limited to 'gdb/doc')
-rw-r--r--gdb/doc/ChangeLog14
-rw-r--r--gdb/doc/Makefile.in26
-rw-r--r--gdb/doc/gdb.texinfo9
3 files changed, 38 insertions, 11 deletions
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index dfc7138..5b15a2a 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,17 @@
+2000-04-23 Eli Zaretskii <eliz@is.elta.co.il>
+
+ * Makefile.in (GDBMI_DIR): New variable.
+ (SET_TEXINPUTS): Add $(GDBMI_DIR).
+ (SFILES_DOC): Add $(GDBMI_DIR)/gdbmi.texinfo.
+ (gdbmi.texinfo): New target, for texi2roff.
+ (gdb.me, gdb.ms, gdb.mm): Depend on gdbmi.texinfo.
+ (gdb.info, gdb_toc.html): Add "-I ${GDBMI_DIR}".
+
+ * gdb.texinfo (Top): Add GDB/MI to the main menu and @include
+ gdbmi.texinfo.
+ (Mode Options): Add xref to GDB/MI docs and remove a FIXME
+ comment.
+
2000-04-17 Elena Zannoni <ezannoni@kwikemart.cygnus.com>
* gdb.texinfo (Files): Update description of add-symbol-file
diff --git a/gdb/doc/Makefile.in b/gdb/doc/Makefile.in
index cef11bf..57fac5c 100644
--- a/gdb/doc/Makefile.in
+++ b/gdb/doc/Makefile.in
@@ -56,7 +56,11 @@ 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
# There may be alternate predefined collections of switches to configure
# the GDB manual. Normally this is not done in synch with the software
@@ -93,7 +97,7 @@ SFILES_INCLUDED = gdb-cfg.texi $(srcdir)/annotate.texi
SFILES_LOCAL = $(srcdir)/gdb.texinfo GDBvn.texi $(SFILES_INCLUDED)
-SFILES_DOC = $(SFILES_LOCAL) \
+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.
@@ -233,10 +237,10 @@ gdb.ps: gdb.dvi
$(DVIPS) -o $@ $?
# 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.
@@ -275,8 +279,14 @@ inc-hist.texinfo: ${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.texinfo
+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' \
@@ -291,7 +301,7 @@ gdb.me: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texinfo
>gdb.me
# gdb manual suitable for [gtn]roff -ms
-gdb.ms: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texinfo
+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' \
@@ -308,7 +318,7 @@ gdb.ms: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texinfo
# 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.texinfo
+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' \
@@ -326,7 +336,7 @@ gdb.mm: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texinfo
# GDB MANUAL: HTML file
gdb_toc.html: ${SFILES_DOC}
- $(MAKEHTML) $(MAKEHTMLFLAGS) -I ${READLINE_DIR} -I $(srcdir) $(srcdir)/gdb.texinfo
+ $(MAKEHTML) $(MAKEHTMLFLAGS) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) $(srcdir)/gdb.texinfo
# GDB GUI MANUAL: TeX dvi file
gdbgui.dvi : gdbgui.texinfo ${SFILES_DOC}
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index d909466..4628dd0 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -24,6 +24,9 @@
@c readline appendices use @vindex
@syncodeindex vr cp
+@c gdbmi uses @findex
+@syncodeindex fn cp
+
@c !!set GDB manual's edition---not the same as GDB version!
@set EDITION Eighth
@@ -142,6 +145,7 @@ Copyright (C) 1988-2000 Free Software Foundation, Inc.
* Sequences:: Canned sequences of commands
* Emacs:: Using @value{GDBN} under @sc{gnu} Emacs
* Annotations:: @value{GDBN}'s annotation interface.
+* GDB/MI:: @value{GDBN}'s Machine Interface.
* GDB Bugs:: Reporting bugs in @value{GDBN}
* Formatting Documentation:: How to format and print @value{GDBN} documentation
@@ -1040,9 +1044,7 @@ Use the interpreter @var{interp} for interface with the controlling
program or device. This option is meant to be set by programs which
communicate with @value{GDBN} using it as a back end. For example,
@samp{--interpreter=mi} causes @value{GDBN} to use the @dfn{gdbmi
-interface}.
-@c FIXME: There should be an @xref here to the GDB/MI docs, but
-@c gdbmi.texi doesn't have a single node to reference!
+interface} (@pxref{GDB/MI, , The @sc{gdb/mi} Interface}).
@item -write
@cindex @code{--write}
@@ -12204,6 +12206,7 @@ each value is printed in its own window.
@end ignore
@include annotate.texi
+@include gdbmi.texinfo
@node GDB Bugs
@chapter Reporting Bugs in @value{GDBN}