[08/14] Fix gdb.events.inferior_call documentation
Commit Message
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-08 Tom Tromey <tom@tromey.com>
PR python/18909:
* python.texi (Events In Python): Fix inferior_call
documentation.
---
gdb/doc/ChangeLog | 6 ++++++
gdb/doc/python.texi | 20 ++++++++++++++------
2 files changed, 20 insertions(+), 6 deletions(-)
Comments
> From: Tom Tromey <tom@tromey.com>
> Cc: Tom Tromey <tom@tromey.com>
> Date: Sat, 8 Sep 2018 14:14:11 -0600
>
> 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-08 Tom Tromey <tom@tromey.com>
>
> PR python/18909:
> * python.texi (Events In Python): Fix inferior_call
> documentation.
OK, thanks.
@@ -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