Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Tom Tromey <tom@tromey.com>
To: gdb-patches@sourceware.org
Cc: Tom Tromey <tom@tromey.com>
Subject: [PATCH 08/14] Fix gdb.events.inferior_call documentation
Date: Sat, 08 Sep 2018 20:14:00 -0000	[thread overview]
Message-ID: <20180908201417.13444-9-tom@tromey.com> (raw)
In-Reply-To: <20180908201417.13444-1-tom@tromey.com>

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(-)

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 2b3c8a91fd6..47691c448d2 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
-- 
2.13.6


  parent reply	other threads:[~2018-09-08 20:14 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-08 20:14 [PATCH 00/14] Many small Python documentation fixes Tom Tromey
2018-09-08 20:14 ` [PATCH 10/14] Mention Python versions in the documentation Tom Tromey
2018-09-08 21:16   ` Eli Zaretskii
2018-09-08 20:14 ` [PATCH 07/14] Update Python frame filter documentation Tom Tromey
2018-09-08 21:09   ` Eli Zaretskii
2018-09-08 20:14 ` Tom Tromey [this message]
2018-09-08 21:10   ` [PATCH 08/14] Fix gdb.events.inferior_call documentation Eli Zaretskii
2018-09-08 20:14 ` [PATCH 02/14] Fix typo in pretty-printer example Tom Tromey
2018-09-08 21:12   ` Eli Zaretskii
2018-09-08 20:14 ` [PATCH 14/14] Remove periods from Python section titles Tom Tromey
2018-09-08 21:14   ` Eli Zaretskii
2018-09-08 20:14 ` [PATCH 13/14] Swap two sentences in the Pretty Printing API node Tom Tromey
2018-09-08 21:11   ` Eli Zaretskii
2018-09-08 20:14 ` [PATCH 01/14] Update Python Block.end documentation Tom Tromey
2018-09-08 20:14 ` [PATCH 05/14] Avoid warnings from makeinfo Tom Tromey
2018-09-08 21:09   ` Eli Zaretskii
2018-09-08 20:14 ` [PATCH 06/14] Reword gdb.GdbError text Tom Tromey
2018-09-08 21:16   ` Eli Zaretskii
2018-09-08 20:14 ` [PATCH 04/14] Fix help text for "python" command Tom Tromey
2018-09-08 20:14 ` [PATCH 12/14] Mention virtual tables in Python dynamic_type documentation Tom Tromey
2018-09-08 21:13   ` Eli Zaretskii
2018-09-08 20:14 ` [PATCH 11/14] Small typo fix in Basic Python node Tom Tromey
2018-09-08 21:08   ` Eli Zaretskii
2018-09-08 20:14 ` [PATCH 03/14] Document that Frame.block can throw Tom Tromey
2018-09-08 21:07   ` Eli Zaretskii
2018-09-08 20:22 ` [PATCH 09/14] Update Python unwinder documentation Tom Tromey
2018-09-08 21:18   ` Eli Zaretskii
2018-09-10 13:44 ` [PATCH 00/14] Many small Python documentation fixes Tom Tromey

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180908201417.13444-9-tom@tromey.com \
    --to=tom@tromey.com \
    --cc=gdb-patches@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox