Re: [PATCH 10/10] gdb/python: Add new gdb.unwinder.FrameId class

[Eli Zaretskii <eliz@gnu.org>]

> Cc: Andrew Burgess <aburgess@redhat.com>
> Date: Fri, 10 Mar 2023 14:55:27 +0000
> From: Andrew Burgess via Gdb-patches <gdb-patches@sourceware.org>
> 
> When writing an unwinder it is necessary to create a new class to act
> as a frame-id.  This new class is almost certainly just going to set a
> 'sp' and 'pc' attribute within the instance.
> 
> This commit adds a little helper class gdb.unwinder.FrameId that does
> this job.  Users can make use of this to avoid having to write out
> standard boilerplate code any time they write an unwinder.
> 
> Of course, if the user wants their FrameId class to be more
> complicated in some way, then they can still write their own class,
> just like they could before.
> 
> I've simplified the example code in the documentation to now use the
> new helper class, and I've also made use of this helper within the
> testsuite.
> 
> Any existing user code will continue to work just as it did before
> after this change.
> ---
>  gdb/NEWS                              |  5 +++
>  gdb/doc/python.texi                   | 49 ++++++++++++++++++++++-----
>  gdb/python/lib/gdb/unwinder.py        | 26 ++++++++++++++
>  gdb/testsuite/gdb.python/py-unwind.py | 16 +--------
>  4 files changed, 73 insertions(+), 23 deletions(-)

Thanks.

> diff --git a/gdb/NEWS b/gdb/NEWS
> index c4f7de11c6e..c5aa256c1bd 100644
> --- a/gdb/NEWS
> +++ b/gdb/NEWS
> @@ -134,6 +134,11 @@ show always-read-ctf
>       now use either an integer or a gdb.Value object for each of its
>       'sp', 'pc', and 'special' attributes.
>  
> +  ** A new class gdb.unwinder.FrameId has been added.  Instrances of
                                                          ^^^^^^^^^^
A typo.

> +A helper class is provided in the @code{gdb.unwinder} module that can
> +be used to represent a frame-id
> +(@pxref{gdb.unwinder.FrameId,,@code{gdb.unwinder.FrameId}}).
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Is this justified? does using the 3rd arg of @pxref produce a much
better cross-reference, in both Info and printed formats?

> +The @var{special} argument is optional, if specified it should be a
                                         ^             ^
Semi-colon there, and a comma missing after "if specified".

Reviewed-By: Eli Zaretskii <eliz@gnu.org>