Message ID | 20190305170544.23216-1-simon.marchi@efficios.com |
---|---|
State | New, archived |
Headers |
Received: (qmail 49995 invoked by alias); 5 Mar 2019 17:06:07 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: <gdb-patches.sourceware.org> List-Unsubscribe: <mailto:gdb-patches-unsubscribe-##L=##H@sourceware.org> List-Subscribe: <mailto:gdb-patches-subscribe@sourceware.org> List-Archive: <http://sourceware.org/ml/gdb-patches/> List-Post: <mailto:gdb-patches@sourceware.org> List-Help: <mailto:gdb-patches-help@sourceware.org>, <http://sourceware.org/ml/#faqs> Sender: gdb-patches-owner@sourceware.org Delivered-To: mailing list gdb-patches@sourceware.org Received: (qmail 49977 invoked by uid 89); 5 Mar 2019 17:06:06 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-26.9 required=5.0 tests=BAYES_00, GIT_PATCH_0, GIT_PATCH_1, GIT_PATCH_2, GIT_PATCH_3, RCVD_IN_DNSWL_NONE, SPF_PASS autolearn=ham version=3.3.2 spammy=H*r:10026, Small X-HELO: mail.efficios.com Received: from mail.efficios.com (HELO mail.efficios.com) (167.114.142.138) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Tue, 05 Mar 2019 17:06:05 +0000 Received: from localhost (ip6-localhost [IPv6:::1]) by mail.efficios.com (Postfix) with ESMTP id 22CD3ACD6D; Tue, 5 Mar 2019 12:06:03 -0500 (EST) Received: from mail.efficios.com ([IPv6:::1]) by localhost (mail02.efficios.com [IPv6:::1]) (amavisd-new, port 10032) with ESMTP id zfMP1bteBEX2; Tue, 5 Mar 2019 12:06:02 -0500 (EST) Received: from localhost (ip6-localhost [IPv6:::1]) by mail.efficios.com (Postfix) with ESMTP id D7FE9ACD69; Tue, 5 Mar 2019 12:06:02 -0500 (EST) DKIM-Filter: OpenDKIM Filter v2.10.3 mail.efficios.com D7FE9ACD69 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=efficios.com; s=default; t=1551805562; bh=oGXPCwQxPT8/nvgd3vkjiUqgPxI/ZZBqmrXRmwdZCxY=; h=From:To:Date:Message-Id:MIME-Version; b=qN0eM5yb8QPYY0MTALBAysFPKz0bIthEF6JSgsO+spKtJ/umVYOKL5X5DpalDb9Dx Y5kzFvqrr+yYwM/pqt2LrBM57giLocSkLJaJduzaFqtSCk5Q9sgSYrKRsYAWUgNOFC XexWhjqMcNkW7qwcGfq/AJJp2w5c7wX5OshGGbujnA/IAfrC74BOmmnTAtXlvWQvGl d8GcVI5Bc9ZxZYulhcKj6VICRUgWn5KHrlXjBZidnsE9CH34sCmiTWqKKM+yADJm1h peiNMitq5aPmErpLrWp5ZqV1ScCpSYEXy9AhhmYoTVt2i4SWMJ18IsR5uVa/dEbnO3 o7yu0CyRuOL5g== Received: from mail.efficios.com ([IPv6:::1]) by localhost (mail02.efficios.com [IPv6:::1]) (amavisd-new, port 10026) with ESMTP id O8hyuwk9QKMs; Tue, 5 Mar 2019 12:06:02 -0500 (EST) Received: from smarchi-efficios.internal.efficios.com (192-222-157-41.qc.cable.ebox.net [192.222.157.41]) by mail.efficios.com (Postfix) with ESMTPSA id B3949ACD62; Tue, 5 Mar 2019 12:06:02 -0500 (EST) From: Simon Marchi <simon.marchi@efficios.com> To: gdb-patches@sourceware.org Cc: Kevin Buettner <kevinb@redhat.com>, Eli Zaretskii <eliz@gnu.org>, Simon Marchi <simon.marchi@efficios.com> Subject: [PATCH] Small fix to gdb.Value constructor doc Date: Tue, 5 Mar 2019 12:05:44 -0500 Message-Id: <20190305170544.23216-1-simon.marchi@efficios.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable |
Commit Message
Simon Marchi
March 5, 2019, 5:05 p.m. UTC
The synopsis of the two-parameters form of the gdb.Value constructor is currently shown as Value.__init__ (val, [, type ]) in the documentation. First, there is an extra comma, which I think we can remove in any case. Then, since the type parameter is not optional, I would not put in between square brackets. Those usually indicate that something is optional. With this patch, it appears as: Value.__init__ (val, type) gdb/doc/ChangeLog: * python.texi (Values From Inferior): Change synopsys of the second form of Value.__init__. --- gdb/doc/python.texi | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Comments
> From: Simon Marchi <simon.marchi@efficios.com> > Cc: Kevin Buettner <kevinb@redhat.com>, > Eli Zaretskii <eliz@gnu.org>, > Simon Marchi <simon.marchi@efficios.com> > Date: Tue, 5 Mar 2019 12:05:44 -0500 > > gdb/doc/ChangeLog: > > * python.texi (Values From Inferior): Change synopsys of the > second form of Value.__init__. Thanks, this is OK, but please take care of this gotcha: > -@defun Value.__init__ (@var{val}, @r{[}, type @r{]}) > +@defun Value.__init__ (@var{val}, type) "type" should also be in @var.
On Tue, 5 Mar 2019 12:05:44 -0500 Simon Marchi <simon.marchi@efficios.com> wrote: > The synopsis of the two-parameters form of the gdb.Value constructor is > currently shown as > > Value.__init__ (val, [, type ]) > > in the documentation. > > First, there is an extra comma, which I think we can remove in any > case. > > Then, since the type parameter is not optional, I would not put in > between square brackets. Those usually indicate that something is > optional. > > With this patch, it appears as: > > Value.__init__ (val, type) I agree with your changes. Thanks for fixing this! Kevin
On 2019-03-05 12:28, Eli Zaretskii wrote: >> From: Simon Marchi <simon.marchi@efficios.com> >> Cc: Kevin Buettner <kevinb@redhat.com>, >> Eli Zaretskii <eliz@gnu.org>, >> Simon Marchi <simon.marchi@efficios.com> >> Date: Tue, 5 Mar 2019 12:05:44 -0500 >> >> gdb/doc/ChangeLog: >> >> * python.texi (Values From Inferior): Change synopsys of the >> second form of Value.__init__. > > Thanks, this is OK, but please take care of this gotcha: > >> -@defun Value.__init__ (@var{val}, @r{[}, type @r{]}) >> +@defun Value.__init__ (@var{val}, type) > > "type" should also be in @var. I pushed it with this fixed. Thanks, Simon
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi index 7f6f52c4df..aaaa4ff1a6 100644 --- a/gdb/doc/python.texi +++ b/gdb/doc/python.texi @@ -735,7 +735,7 @@ its result is used. @end table @end defun -@defun Value.__init__ (@var{val}, @r{[}, type @r{]}) +@defun Value.__init__ (@var{val}, type) This second form of the @code{gdb.Value} constructor returns a @code{gdb.Value} of type @var{type} where the value contents are taken from the Python buffer object specified by @var{val}. The number of