This is the mail archive of the
gdb-cvs@sourceware.org
mailing list for the GDB project.
[binutils-gdb] Fix gdb.events.inferior_call documentation
- From: Tom Tromey <tromey at sourceware dot org>
- To: gdb-cvs at sourceware dot org
- Date: 10 Sep 2018 13:49:55 -0000
- Subject: [binutils-gdb] Fix gdb.events.inferior_call documentation
https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=fb5af5e335202bc94c292c83eaa328633cd5d924
commit fb5af5e335202bc94c292c83eaa328633cd5d924
Author: Tom Tromey <tom@tromey.com>
Date: Sat Sep 8 10:59:14 2018 -0600
Fix gdb.events.inferior_call documentation
PR python/18909 points out that the gdb.events.inferior_call
documentation was incorrect. This patch brings it in line with the
code.
gdb/doc/ChangeLog
2018-09-10 Tom Tromey <tom@tromey.com>
PR python/18909:
* python.texi (Events In Python): Fix inferior_call
documentation.
Diff:
---
gdb/doc/ChangeLog | 6 ++++++
gdb/doc/python.texi | 20 ++++++++++++++------
2 files changed, 20 insertions(+), 6 deletions(-)
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index f8b958d..705028a 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,5 +1,11 @@
2018-09-10 Tom Tromey <tom@tromey.com>
+ PR python/18909:
+ * python.texi (Events In Python): Fix inferior_call
+ documentation.
+
+2018-09-10 Tom Tromey <tom@tromey.com>
+
PR python/17752:
* python.texi (Frame Filter API): Remove period from subsection
title. Mention 100 as good default priority.
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 2b3c8a9..47691c4 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -2987,9 +2987,16 @@ A reference to the program space (@code{gdb.Progspace}) whose objfile list has
been cleared. @xref{Progspaces In Python}.
@end defvar
-@item events.inferior_call_pre
-Emits @code{gdb.InferiorCallPreEvent} which indicates that a function in
-the inferior is about to be called.
+@item events.inferior_call
+Emits events just before and after a function in the inferior is
+called by @value{GDBN}. Before an inferior call, this emits an event
+of type @code{gdb.InferiorCallPreEvent}, and after an inferior call,
+this emits an event of type @code{gdb.InferiorCallPostEvent}.
+
+@table @code
+@tindex gdb.InferiorCallPreEvent
+@item @code{gdb.InferiorCallPreEvent}
+Indicates that a function in the inferior is about to be called.
@defvar InferiorCallPreEvent.ptid
The thread in which the call will be run.
@@ -2999,9 +3006,9 @@ The thread in which the call will be run.
The location of the function to be called.
@end defvar
-@item events.inferior_call_post
-Emits @code{gdb.InferiorCallPostEvent} which indicates that a function in
-the inferior has returned.
+@tindex gdb.InferiorCallPostEvent
+@item @code{gdb.InferiorCallPostEvent}
+Indicates that a function in the inferior has just been called.
@defvar InferiorCallPostEvent.ptid
The thread in which the call was run.
@@ -3010,6 +3017,7 @@ The thread in which the call was run.
@defvar InferiorCallPostEvent.address
The location of the function that was called.
@end defvar
+@end table
@item events.memory_changed
Emits @code{gdb.MemoryChangedEvent} which indicates that the memory of the