aboutsummaryrefslogtreecommitdiff
path: root/gdb/doc
diff options
context:
space:
mode:
authorPedro Alves <pedro@palves.net>2022-09-30 17:23:03 +0100
committerPedro Alves <pedro@palves.net>2022-10-21 22:05:16 +0100
commit62fe72fda1f79543f150e63dada6abf8e7ad34a5 (patch)
tree4a062f6ba04a5df9894d79409ad2985360dc5809 /gdb/doc
parent129d1afcc50c0aa3cf69fb3c5d4d8c825bec1061 (diff)
downloadgdb-62fe72fda1f79543f150e63dada6abf8e7ad34a5.zip
gdb-62fe72fda1f79543f150e63dada6abf8e7ad34a5.tar.gz
gdb-62fe72fda1f79543f150e63dada6abf8e7ad34a5.tar.bz2
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
Diffstat (limited to 'gdb/doc')
-rw-r--r--gdb/doc/python.texi18
1 files changed, 9 insertions, 9 deletions
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 2692211..f73b9a4 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