From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from simark.ca by simark.ca with LMTP id /0NFDIN3kl+xVgAAWB0awg (envelope-from ) for ; Fri, 23 Oct 2020 02:26:11 -0400 Received: by simark.ca (Postfix, from userid 112) id 2574E1EE09; Fri, 23 Oct 2020 02:26:11 -0400 (EDT) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on simark.ca X-Spam-Level: X-Spam-Status: No, score=-1.1 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,MAILING_LIST_MULTI,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.2 Received: from sourceware.org (server2.sourceware.org [8.43.85.97]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by simark.ca (Postfix) with ESMTPS id 0F3651E552 for ; Fri, 23 Oct 2020 02:26:07 -0400 (EDT) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 9131D3858002; Fri, 23 Oct 2020 06:26:06 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 9131D3858002 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1603434366; bh=YqczTkEYVZrLFjTe6QcBx7ClHWZIdCCppTCW/wKSzCA=; h=Date:To:In-Reply-To:Subject:References:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc: From; b=BNXXjpxGYSgEwvYOpynDIAywptR8gZnwiNMvJqXLN0lHOAI1Uzt6caabKKnqHCUbr s1pdHnLVK+sGKAKPOR2cAWOdffMKoOYmbKDjaRDmaipBX3Pox+5QdczDe+nW/XrPzp RDcPOD9G2nZB/NiN0jgfq4S5nRJlmlvNnTie3wzI= Received: from eggs.gnu.org (eggs.gnu.org [IPv6:2001:470:142:3::10]) by sourceware.org (Postfix) with ESMTPS id DBB073858002 for ; Fri, 23 Oct 2020 06:25:44 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org DBB073858002 Received: from fencepost.gnu.org ([2001:470:142:3::e]:60254) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kVqWG-0004yK-A5; Fri, 23 Oct 2020 02:25:44 -0400 Received: from [176.228.60.248] (port=1928 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1kVqWF-0001Wl-AW; Fri, 23 Oct 2020 02:25:44 -0400 Date: Fri, 23 Oct 2020 09:25:28 +0300 Message-Id: <838sbxlaqv.fsf@gnu.org> To: Luis Machado In-Reply-To: <20201022200014.5189-8-luis.machado@linaro.org> (message from Luis Machado via Gdb-patches on Thu, 22 Oct 2020 16:59:57 -0300) Subject: Re: [PATCH v2 07/24] Documentation for memory tagging remote packets References: <20201022200014.5189-1-luis.machado@linaro.org> <20201022200014.5189-8-luis.machado@linaro.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: , From: Eli Zaretskii via Gdb-patches Reply-To: Eli Zaretskii Cc: david.spickett@linaro.org, gdb-patches@sourceware.org Errors-To: gdb-patches-bounces@sourceware.org Sender: "Gdb-patches" > Date: Thu, 22 Oct 2020 16:59:57 -0300 > From: Luis Machado via Gdb-patches > Cc: david.spickett@linaro.org > > gdb/doc/ChangeLog: > > YYYY-MM-DD Luis Machado > > * gdb.texinfo (General Query Packets): Document qMemTags and > QMemTags. > Document the "memory-tagging" feature. Since the last sentence belongs to the same node as the one before it, please don't start it on a new line, but after the previous sentence ends (with 2 spaces between them). > +@item qMemTags:@var{start address},@var{length}:@var{type} > +@cindex fetch memory tags > +@cindex @samp{qMemTags} packet > +Fetch memory tags of type @var{type} from the address range > +@r{[}@var{start address}, @var{start address} + @var{length}@r{)}. The target The expression in @r{...} should be wrapped with @w{..}, so that it doesn't get split between two lines. > +@var{type} is the type of tag, a signed integer, the request wants to fetch. This is ambiguous: does "the request wants to fetch" refer to the tag or to the "signed integer" part? Suggest to move the "a signed integer" part to the end of the sentence. > +tags found in the request memory range. ^^^^^^^ "requested" > +Store memory tags of type @var{type} to the address range > +@r{[}@var{start address}, @var{start address} + @var{length}@r{)}. The target Same comment here about @r{..}. > +If the number of memory tags, @var{nt}, is greater than or equal to the > +number of memory tag granules, @var{ng}, only @var{ng} tags will be > +stored. It is not clear here how NT and NG are related to the parameters of the packet. Can you add something that explains the relation? > +@var{type} is the type of tag, a signed integer, the request wants to store. Same comment as above regarding ambiguity of the sentence. > +@item memory-tagging > +The remote stub supports and implements the required memory tagging > +functionality and understands the @samp{qMemTags} and @samp{QMemTags} packets. This is far enough from the description of these packets to warrant a cross-reference to that description. Please add a cross-reference. Thanks.