From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from eggs.gnu.org (eggs.gnu.org [IPv6:2001:470:142:3::10]) by sourceware.org (Postfix) with ESMTPS id E67D0385C409 for ; Fri, 30 Sep 2022 17:38:08 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org E67D0385C409 Received: from fencepost.gnu.org ([2001:470:142:3::e]:55706) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oeJxf-0005CC-6M; Fri, 30 Sep 2022 13:38:07 -0400 Received: from [87.69.77.57] (port=4783 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oeJxc-0006CD-Ez; Fri, 30 Sep 2022 13:38:05 -0400 Date: Fri, 30 Sep 2022 20:37:51 +0300 Message-Id: <83o7uwdaq8.fsf@gnu.org> From: Eli Zaretskii To: Pedro Alves Cc: ptsneves@gmail.com, gdb-patches@sourceware.org In-Reply-To: <2ad190e6-7892-d3f6-3426-46878c87a4fa@palves.net> (message from Pedro Alves on Fri, 30 Sep 2022 17:41:50 +0100) Subject: Re: [PATCH v3 4/4] gdb/python doc: Move unwinder skeleton code References: <20220528115509.3865342-1-ptsneves@gmail.com> <20220603160139.136115-1-ptsneves@gmail.com> <20220603160139.136115-4-ptsneves@gmail.com> <83wndxbtwn.fsf@gnu.org> <8ed127eb-221b-2b85-1019-1968060f68bc@palves.net> <83y1u0dfjm.fsf@gnu.org> <2ad190e6-7892-d3f6-3426-46878c87a4fa@palves.net> X-Spam-Status: No, score=-7.1 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_BARRACUDACENTRAL, SPF_HELO_PASS, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 30 Sep 2022 17:38:10 -0000 > Cc: ptsneves@gmail.com, gdb-patches@sourceware.org > From: Pedro Alves > 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}.