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 74C2E39CEC24
 for <gdb-patches@sourceware.org>; Fri, 17 Jul 2020 14:31:31 +0000 (GMT)
DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 74C2E39CEC24
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]:54426)
 by eggs.gnu.org with esmtp (Exim 4.90_1)
 (envelope-from <eliz@gnu.org>)
 id 1jwROc-0002Bi-PW; Fri, 17 Jul 2020 10:31:30 -0400
Received: from [176.228.60.248] (port=4114 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 1jwROb-0007wW-TY; Fri, 17 Jul 2020 10:31:30 -0400
Date: Fri, 17 Jul 2020 17:31:18 +0300
Message-Id: <83sgdqi56x.fsf@gnu.org>
From: Eli Zaretskii <eliz@gnu.org>
To: Luis Machado <luis.machado@linaro.org>
Cc: gdb-patches@sourceware.org, Alan.Hayward@arm.com,
 catalin.marinas@arm.com, david.spickett@linaro.org
In-Reply-To: <4ab5c0f4-26fd-94e2-d574-ec15aacc486b@linaro.org> (message from
 Luis Machado on Fri, 17 Jul 2020 11:20:33 -0300)
Subject: Re: [PATCH 21/23] Document new "x" and "print" memory tagging
 extensions
References: <20200715194513.16641-1-luis.machado@linaro.org>
 <20200715194513.16641-22-luis.machado@linaro.org> <83h7u6k6oa.fsf@gnu.org>
 <4ab5c0f4-26fd-94e2-d574-ec15aacc486b@linaro.org>
X-Spam-Status: No, score=-4.2 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, 17 Jul 2020 14:31:32 -0000

> From: Luis Machado <luis.machado@linaro.org>
> Cc: gdb-patches@sourceware.org, Alan.Hayward@arm.com,
>  catalin.marinas@arm.com, david.spickett@linaro.org
> Date: Fri, 17 Jul 2020 11:20:33 -0300
> 
> >> +The @code{print} and @code{x} commands will display tag information when
> > 
> > And here please add a cross-reference to the nodes that describe the
> > 'print' and 'x' commands.
> > 
> 
> I added "@cindex Data" (for print) and "@cindex Memory" (for x) locally.

Not @cindex, @xref.

> >> +The @code{print} command will automatically attempt to validate the logical
> >> +tag against the allocation tag for pointers and addresses, and will display
> >> +a message in case of failure.
> >> +
> >> +The @code{x} command has a @code{m} modifier.  When present, this modifier
> >> +will make the @code{x} command output allocation tag information for a given
> >> +memory region that is being examined.
> > 
> > These should be in the sections that describe these commands, not
> > here.  The idea is to have everything about each command in a single
> > place, and then point there via cross-references from related places.
> > 
> > Thanks.
> > 
> 
> That makes sense. I wanted to make it obvious that memory tagging 
> provided some extra functionality to "print" and "x".
> 
> I suppose I'll just remove these two blocks since their content is 
> already described in both commands, although with slightly different text.

OK.