From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <eliz@gnu.org>
Received: from eggs.gnu.org (eggs.gnu.org [IPv6:2001:470:142:3::10])
 by sourceware.org (Postfix) with ESMTPS id 809C93857C71
 for <gdb-patches@sourceware.org>; Fri, 24 Jul 2020 10:36:57 +0000 (GMT)
DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 809C93857C71
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]:43602)
 by eggs.gnu.org with esmtp (Exim 4.90_1)
 (envelope-from <eliz@gnu.org>)
 id 1jyv4S-00023l-TD; Fri, 24 Jul 2020 06:36:56 -0400
Received: from [176.228.60.248] (port=3160 helo=home-c4e4a596f7)
 by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256)
 (Exim 4.82) (envelope-from <eliz@gnu.org>)
 id 1jyv4S-0001OQ-7v; Fri, 24 Jul 2020 06:36:56 -0400
Date: Fri, 24 Jul 2020 13:36:41 +0300
Message-Id: <83lfj9dwsm.fsf@gnu.org>
From: Eli Zaretskii <eliz@gnu.org>
To: Andrew Burgess <andrew.burgess@embecosm.com>
Cc: gdb-patches@sourceware.org
In-Reply-To: <ec85a6d5476012b0fc59192039e8d1fbff029d15.1595584512.git.andrew.burgess@embecosm.com>
 (message from Andrew Burgess on Fri, 24 Jul 2020 10:57:52 +0100)
Subject: Re: [PATCH 2/2] gdb/python: make more use of RegisterDescriptors
References: <cover.1595584512.git.andrew.burgess@embecosm.com>
 <ec85a6d5476012b0fc59192039e8d1fbff029d15.1595584512.git.andrew.burgess@embecosm.com>
X-Spam-Status: No, score=-4.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 <gdb-patches.sourceware.org>
List-Unsubscribe: <http://sourceware.org/mailman/options/gdb-patches>,
 <mailto:gdb-patches-request@sourceware.org?subject=unsubscribe>
List-Archive: <https://sourceware.org/pipermail/gdb-patches/>
List-Post: <mailto:gdb-patches@sourceware.org>
List-Help: <mailto:gdb-patches-request@sourceware.org?subject=help>
List-Subscribe: <http://sourceware.org/mailman/listinfo/gdb-patches>,
 <mailto:gdb-patches-request@sourceware.org?subject=subscribe>
X-List-Received-Date: Fri, 24 Jul 2020 10:36:58 -0000

> From: Andrew Burgess <andrew.burgess@embecosm.com>
> Date: Fri, 24 Jul 2020 10:57:52 +0100
> 
> +A @code{gdb.RegisterDescriptor} object, see @ref{Registers In Python}
> +for further information.

Please add a comma after the closing brace of @ref.  Newer versions of
Texinfo don't need that, but older ones will barf.

> +@item
> +A @value{GDBN} internal, platform specific number.  Using these
> +numbers is supported for historic reasons, but is not recommended as
> +future changes to @value{GDBN} could change the mapping between numbers
> +and the registers they represent, breaking any Python code.  The

I suggest "breaking any Python code that uses the platform-specific
numbers", to qualify the breakage.

The documentation part is okay with these nits fixed.  Thanks.