public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Paulo Neves <ptsneves@gmail.com>
To: gdb-patches@sourceware.org
Cc: Paulo Neves <ptsneves@gmail.com>
Subject: [PATCH v3 4/4] gdb/python doc: Move unwinder skeleton code
Date: Fri,  3 Jun 2022 18:01:39 +0200	[thread overview]
Message-ID: <20220603160139.136115-4-ptsneves@gmail.com> (raw)
In-Reply-To: <20220603160139.136115-1-ptsneves@gmail.com>

This way all the concepts mentioned in the skeleton code are
previously detailed.
---
 gdb/doc/python.texi | 50 ++++++++++++++++++++++-----------------------
 1 file changed, 25 insertions(+), 25 deletions(-)

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index e2821755851..1deeae82b9b 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -2787,6 +2787,31 @@ values see @ref{gdbpy_frame_read_register,,Frame.read_register}.
 @var{value} is a register value (a @code{gdb.Value} object).
 @end defun
 
+@subheading Registering a Unwinder
+
+An object file, a program space, and the @value{GDBN} proper can have
+unwinders registered with it.
+
+The @code{gdb.unwinder} module provides the function to register a
+unwinder:
+
+@defun gdb.unwinder.register_unwinder (locus, unwinder, replace=False)
+@var{locus} is specifies an object file or a program space to which
+@var{unwinder} is added.  Passing @code{None} or @code{gdb} adds
+@var{unwinder} to the @value{GDBN}'s global unwinder list.  The newly
+added @var{unwinder} will be called before any other unwinder from the
+same locus.  Two unwinders in the same locus cannot have the same
+name.  An attempt to add a unwinder with already existing name raises
+an exception unless @var{replace} is @code{True}, in which case the
+old unwinder is deleted.
+@end defun
+
+@subheading Unwinder Precedence
+
+@value{GDBN} first calls the unwinders from all the object files in no
+particular order, then the unwinders from the current program space,
+and finally the unwinders from @value{GDBN}.
+
 @subheading Unwinder Skeleton Code
 
 @value{GDBN} comes with the module containing the base @code{Unwinder}
@@ -2830,31 +2855,6 @@ class MyUnwinder(Unwinder):
 gdb.unwinder.register_unwinder (<locus>, MyUnwinder, replace=<True|False>)
 @end smallexample
 
-@subheading Registering a Unwinder
-
-An object file, a program space, and the @value{GDBN} proper can have
-unwinders registered with it.
-
-The @code{gdb.unwinder} module provides the function to register a
-unwinder:
-
-@defun gdb.unwinder.register_unwinder (locus, unwinder, replace=False)
-@var{locus} is specifies an object file or a program space to which
-@var{unwinder} is added.  Passing @code{None} or @code{gdb} adds
-@var{unwinder} to the @value{GDBN}'s global unwinder list.  The newly
-added @var{unwinder} will be called before any other unwinder from the
-same locus.  Two unwinders in the same locus cannot have the same
-name.  An attempt to add a unwinder with already existing name raises
-an exception unless @var{replace} is @code{True}, in which case the
-old unwinder is deleted.
-@end defun
-
-@subheading Unwinder Precedence
-
-@value{GDBN} first calls the unwinders from all the object files in no
-particular order, then the unwinders from the current program space,
-and finally the unwinders from @value{GDBN}.
-
 @node Xmethods In Python
 @subsubsection Xmethods In Python
 @cindex xmethods in Python
-- 
2.25.1


  parent reply	other threads:[~2022-06-03 16:01 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-28 11:55 python unwinder doc improvement Paulo Neves
2022-05-28 11:55 ` [PATCH 1/2] gdb/python doc: Add register_unwinder to code example Paulo Neves
2022-05-28 12:20   ` Eli Zaretskii
2022-06-21 11:17     ` Paulo Neves
2022-06-21 12:19       ` Eli Zaretskii
2022-09-30 11:59         ` Paulo Neves
2022-09-30 12:25           ` Eli Zaretskii
2022-05-28 11:55 ` [PATCH 2/2] gdb/python doc: Add enable property to the unwinder example Paulo Neves
2022-05-28 12:22   ` Eli Zaretskii
2022-05-28 13:35     ` Paulo Neves
2022-05-28 13:29 ` [PATCH v2 1/3] gdb/python doc: Add register_unwinder to code example Paulo Neves
2022-05-28 13:29   ` [PATCH v2 2/3] gdb/python doc: Add enable property to the unwinder example Paulo Neves
2022-05-30  9:57     ` Andrew Burgess
2022-06-03 15:54       ` Paulo Neves
2022-05-28 13:29   ` [PATCH v2 3/3] gdb/python doc: Fix confusion between gdb.unwinders and gdb.unwinder Paulo Neves
2022-05-30  9:33     ` Andrew Burgess
2022-05-30  9:55   ` [PATCH v2 1/3] gdb/python doc: Add register_unwinder to code example Andrew Burgess
2022-05-30 10:12     ` Paulo Neves
2022-06-03 16:01 ` [PATCH v3 1/4] " Paulo Neves
2022-06-03 16:01   ` [PATCH v3 2/4] gdb/python doc: Add enable property to the unwinder example Paulo Neves
2022-06-03 16:17     ` Eli Zaretskii
2022-06-03 16:01   ` [PATCH v3 3/4] gdb/python doc: Fix confusion between gdb.unwinders and gdb.unwinder Paulo Neves
2022-06-03 16:17     ` Eli Zaretskii
2022-06-03 16:01   ` Paulo Neves [this message]
2022-06-03 16:20     ` [PATCH v3 4/4] gdb/python doc: Move unwinder skeleton code Eli Zaretskii
2022-06-03 16:38       ` Paulo Neves
2022-09-30 14:50       ` Pedro Alves
2022-09-30 15:53         ` Eli Zaretskii
2022-09-30 16:41           ` Pedro Alves
2022-09-30 17:37             ` Eli Zaretskii
2022-10-21 21:07               ` Pedro Alves
2022-10-22  6:41                 ` Paulo Neves
2022-10-22  6:41                   ` Paulo Neves
2022-06-03 16:17   ` [PATCH v3 1/4] gdb/python doc: Add register_unwinder to code example Eli Zaretskii

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=20220603160139.136115-4-ptsneves@gmail.com \
    --to=ptsneves@gmail.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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).