public inbox for gdb-cvs@sourceware.org
help / color / mirror / Atom feed
* [binutils-gdb] Improve Python Unwinders documentation
@ 2022-10-21 21:06 Pedro Alves
0 siblings, 0 replies; only message in thread
From: Pedro Alves @ 2022-10-21 21:06 UTC (permalink / raw)
To: gdb-cvs
https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=62fe72fda1f79543f150e63dada6abf8e7ad34a5
commit 62fe72fda1f79543f150e63dada6abf8e7ad34a5
Author: Pedro Alves <pedro@palves.net>
Date: Fri Sep 30 17:23:03 2022 +0100
Improve Python Unwinders documentation
- avoid "GDB proper" to refer to global locus, as object files and
program spaces are also GDB proper.
- gdb.register_unwinder does not accept locus=gdb.
- "a unwinder" -> "an unwinder"
Approved-by: Eli Zaretskii <eliz@gnu.org>
Change-Id: I98c1b1000e1063815238e945ca71ec6f37b5702e
Diff:
---
gdb/doc/python.texi | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 2692211f388..f73b9a43a86 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -2861,21 +2861,21 @@ class MyUnwinder(Unwinder):
@end smallexample
-@subheading Registering a Unwinder
+@subheading Registering an Unwinder
-An object file, a program space, and the @value{GDBN} proper can have
-unwinders registered with it.
+Object files and program spaces can have unwinders registered with
+them. In addition, you can also register unwinders globally.
-The @code{gdb.unwinders} module provides the function to register a
+The @code{gdb.unwinders} module provides the function to register an
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
+@var{locus} specifies to which unwinder list to prepend the
+@var{unwinder}. It can be either an object file, a program space, or
+@code{None}, in which case the unwinder is registered globally. 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
+name. An attempt to add an unwinder with an already existing name raises
an exception unless @var{replace} is @code{True}, in which case the
old unwinder is deleted.
@end defun
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2022-10-21 21:06 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-10-21 21:06 [binutils-gdb] Improve Python Unwinders documentation Pedro Alves
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).