From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 15433 invoked by alias); 28 Dec 2013 03:30:12 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 15398 invoked by uid 89); 28 Dec 2013 03:30:09 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-1.1 required=5.0 tests=AWL,BAYES_00 autolearn=ham version=3.3.2 X-HELO: rock.gnat.com Received: from rock.gnat.com (HELO rock.gnat.com) (205.232.38.15) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with (AES256-SHA encrypted) ESMTPS; Sat, 28 Dec 2013 03:30:08 +0000 Received: from localhost (localhost.localdomain [127.0.0.1]) by filtered-rock.gnat.com (Postfix) with ESMTP id BF2C81164A2; Fri, 27 Dec 2013 22:30:06 -0500 (EST) Received: from rock.gnat.com ([127.0.0.1]) by localhost (rock.gnat.com [127.0.0.1]) (amavisd-new, port 10024) with LMTP id qcHdPui0w00z; Fri, 27 Dec 2013 22:30:06 -0500 (EST) Received: from joel.gnat.com (localhost.localdomain [127.0.0.1]) by rock.gnat.com (Postfix) with ESMTP id 5672D116455; Fri, 27 Dec 2013 22:30:06 -0500 (EST) Received: by joel.gnat.com (Postfix, from userid 1000) id 39CB2E0833; Sat, 28 Dec 2013 07:30:03 +0400 (RET) Date: Sat, 28 Dec 2013 03:30:00 -0000 From: Joel Brobecker To: Eli Zaretskii Cc: gdb-patches@sourceware.org Subject: Re: [RFA/doco] Fix gdb.Field attributes documentation for enum types. Message-ID: <20131228033003.GD4532@adacore.com> References: <1387783386-6072-1-git-send-email-brobecker@adacore.com> <834n5z8rxl.fsf@gnu.org> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="ew6BAiZeqk4r7MaW" Content-Disposition: inline In-Reply-To: <834n5z8rxl.fsf@gnu.org> User-Agent: Mutt/1.5.21 (2010-09-15) X-SW-Source: 2013-12/txt/msg00974.txt.bz2 --ew6BAiZeqk4r7MaW Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-length: 733 > > gdb/doc/ChangeLog: > > > > * gdb.texinfo (Types In Python): Fix the documentation of > > attribute "bitpos" in class gdb.Field for enum types. Add > > documentation for attribute "enumval" in that same class. > > > > Tested on x86_linux. OK to check in? > > I guess so, although I'm not sure the reader will always understand > the exact meaning of "bit position of the field". Maybe we should > explain some more? This is independent from the change I was making, but true, so attached is a patch that tries to help. In the meantime, the patch above is now in. gdb/doc/ChangeLog: * gdb.texinfo (Types In Python): Clarify the documentation of attribute gdb.Field.bitpos. -- Joel --ew6BAiZeqk4r7MaW Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="0001-Clarify-documentation-of-the-gdb.Field.bitpos-attrib.patch" Content-length: 1069 >From 616c57df75b3e0f3f943f5d13ac2f3cb9ac28c17 Mon Sep 17 00:00:00 2001 From: Joel Brobecker Date: Sat, 28 Dec 2013 07:24:36 +0400 Subject: [PATCH] Clarify documentation of the gdb.Field.bitpos attribute gdb/doc/ChangeLog: * gdb.texinfo (Types In Python): Clarify the documentation of attribute gdb.Field.bitpos. --- gdb/doc/gdb.texinfo | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index 3fa0999..a60e6cf 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -24338,8 +24338,8 @@ Each field is a @code{gdb.Field} object, with some pre-defined attributes: @table @code @item bitpos This attribute is not available for @code{enum} or @code{static} -(as in C@t{++} or Java) fields. The value is the bit position of -the field. +(as in C@t{++} or Java) fields. The value is the position, counting +in bits, from the start of the containing type. @item enumval This attribute is only available for @code{enum} fields, and its value -- 1.8.3.2 --ew6BAiZeqk4r7MaW--