From: Eli Zaretskii <eliz@gnu.org>
To: Pedro Alves <pedro@palves.net>
Cc: ptsneves@gmail.com, gdb-patches@sourceware.org
Subject: Re: [PATCH v3 4/4] gdb/python doc: Move unwinder skeleton code
Date: Fri, 30 Sep 2022 20:37:51 +0300 [thread overview]
Message-ID: <83o7uwdaq8.fsf@gnu.org> (raw)
In-Reply-To: <2ad190e6-7892-d3f6-3426-46878c87a4fa@palves.net> (message from Pedro Alves on Fri, 30 Sep 2022 17:41:50 +0100)
> Cc: ptsneves@gmail.com, gdb-patches@sourceware.org
> From: Pedro Alves <pedro@palves.net>
> Date: Fri, 30 Sep 2022 17:41:50 +0100
>
> diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
> index 2692211f388..4a7b047c3e0 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 which unwinder list the @var{unwinder} is
> +prepended to. 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
That's fine, but let's avoid passive tense where we can (and make the
sentence easier to grasp while at that). So:
@var{locus} specifies to which unwinder list to prepend the
@var{unwinder}.
next prev parent reply other threads:[~2022-09-30 17:38 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 ` [PATCH v3 4/4] gdb/python doc: Move unwinder skeleton code Paulo Neves
2022-06-03 16:20 ` 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 [this message]
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=83o7uwdaq8.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=gdb-patches@sourceware.org \
--cc=pedro@palves.net \
--cc=ptsneves@gmail.com \
/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).