FreeChainXenon/binutils-gdb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve Python Unwinders documentation

Browse source 
- 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
This commit is contained in:
Pedro Alves 2022-09-30 17:23:03 +01:00
parent 129d1afcc5
commit 62fe72fda1
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
gdb/doc/python.texi
View file

@ -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