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 A88DD39540F4 for ; Wed, 17 Jun 2020 18:26:12 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org A88DD39540F4 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=gnu.org Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=eliz@gnu.org Received: from fencepost.gnu.org ([2001:470:142:3::e]:49674) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jlclI-00066z-5J; Wed, 17 Jun 2020 14:26:12 -0400 Received: from [176.228.60.248] (port=4189 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1jlclH-0007iC-27; Wed, 17 Jun 2020 14:26:11 -0400 Date: Wed, 17 Jun 2020 21:25:54 +0300 Message-Id: <83zh91zgzx.fsf@gnu.org> From: Eli Zaretskii To: Andrew Burgess Cc: gdb-patches@sourceware.org In-Reply-To: (message from Andrew Burgess on Wed, 17 Jun 2020 18:38:07 +0100) Subject: Re: [PATCH 3/5] gdb/python: Add gdb.Architecture.registers method References: X-Spam-Status: No, score=-5.1 required=5.0 tests=BAYES_00, KAM_DMARC_STATUS, RCVD_IN_DNSWL_LOW, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) 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: Wed, 17 Jun 2020 18:26:14 -0000 > From: Andrew Burgess > Date: Wed, 17 Jun 2020 18:38:07 +0100 > gdb/ChangeLog: > > * Makefile.in (SUBDIR_PYTHON_SRCS): Add py-registers.c > * python/py-arch.c (archpy_registers): New function. > (arch_object_methods): Add 'registers' method. > * python/py-registers.c: New file. > * python/python-internal.h > (gdbpy_new_register_descriptor_iterator): Declare. > (gdbpy_initialize_registers): Declare. > * python/python.c (do_start_initialization): Call > gdbpy_initialize_registers. > * NEWS: Mention additions to the Python API. > > gdb/testsuite/ChangeLog: > > * gdb.python/py-arch-reg-names.exp: New file. > > gdb/doc/ChangeLog: > > * python.texi (Python API): Add new section the menu. ^^^^^^^^ "to the menu". > (Frames In Python): Add new @anchor. > (Architectures In Python): Document new registers method. > (Registers In Python): New section. The documentation parts are approved, with a few nits: > +@anchor{gdbpy_architecture_registers} > +@defun Architecture.registers (@r{[} @var{reggroup} @r{]}) > +Return a @code{gdb.RegisterDescriptorIterator} (@pxref{Registers In > +Python}) for all of the registers in @var{reggroup}, a string that is > +the name of a register group. If @var{reggroup} is missing, or is the ^^^^^^^ "omitted" is better here. > +empty string, then the register group @dfn{all} is assumed. ^^^^^^^^^ Please use @samp here instead of @dfn. The latter is for markup of terminology, which is not what you want here. > +A @code{gdb.RegisterDescriptor} does not provide the value of a > +register (@pxref{gdbpy_frame_read_register,,@code{Frame.read_register}} for reading a registers ^^^^^^^^^ You meant "register's" here, with the apostrophe, right? Thanks.