From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from simark.ca by simark.ca with LMTP id +OcMALzjkl87YgAAWB0awg (envelope-from ) for ; Fri, 23 Oct 2020 10:07:56 -0400 Received: by simark.ca (Postfix, from userid 112) id E71771EE09; Fri, 23 Oct 2020 10:07:55 -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 0EB271E58D for ; Fri, 23 Oct 2020 10:07:55 -0400 (EDT) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 15F203987C09; Fri, 23 Oct 2020 14:07:54 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 15F203987C09 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1603462074; bh=Nrt+2HqiAh1TEbSL1N3Px+fakIMzXaqnesS/JwZG0Yc=; h=Subject:To:References:Date:In-Reply-To:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc: From; b=YFrumoVbN7UbzAX/irnaGkKaLUzamfpBx39O5B423rC5s9vHzrKX99zk1Gf1VfroZ k8/zC1Rt3ZIqI4ykb7IqucxlM34ULd6vzvEXGArN75rzVxMcvutDuWpIq15GCel10U 86QrJtdq0Y0ZupnVVBATO1/+jabV4V7de8eiy02c= Received: from mail-qk1-x741.google.com (mail-qk1-x741.google.com [IPv6:2607:f8b0:4864:20::741]) by sourceware.org (Postfix) with ESMTPS id 007313858036 for ; Fri, 23 Oct 2020 14:07:51 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 007313858036 Received: by mail-qk1-x741.google.com with SMTP id z6so1210017qkz.4 for ; Fri, 23 Oct 2020 07:07:51 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:to:cc:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=Nrt+2HqiAh1TEbSL1N3Px+fakIMzXaqnesS/JwZG0Yc=; b=GRCkhdznKtZMwS4TwYh6cLfToNJ8Gf/MMCVLlJL9ZU5vwgkAGjlKHKFeOASi2gjpsg YavfbBNif1Y9WOaDxJ2r1qwZBaOv18Qyl+2CeeDpH2xdwL0nxkYPUGdwzTOZ9qVKxEa8 USd5Vx7xY1D66Vsins6RMPAj0kU/4uYGjbvG6ZXknZjXzEEbadG8+vjatLVtnTfGG3Lj 69/dh28QV8CX9R5ySkVQR4J0+Ya/lvffR7Qlv2v+ns33zI1fAFHMG3QlCBb90yWbWUPq Xe4lXu+isOyW4fO9536nS9vPAByg0KcM0PymcAqHBEYPMsLRx27GfwjLph14n3+RwjtT PB2Q== X-Gm-Message-State: AOAM531Maunl08LGNE7bBtTTsZiaK7jnrEc4HYjmyVFcWUxhuXiGvGJ2 R34FZAJ3CVGWBH4bzjMrdD0FPw== X-Google-Smtp-Source: ABdhPJzbp0y4XwcUU6W314q3bfUHE09rs3LKQg1Rqq688fvgRx4DYz8W8oQ1tRMBYIdZzzeGqSSqdg== X-Received: by 2002:a37:c56:: with SMTP id 83mr2138761qkm.304.1603462071540; Fri, 23 Oct 2020 07:07:51 -0700 (PDT) Received: from ?IPv6:2804:7f0:8284:1487:4913:3c4b:c60f:1010? ([2804:7f0:8284:1487:4913:3c4b:c60f:1010]) by smtp.gmail.com with ESMTPSA id g129sm778116qkb.61.2020.10.23.07.07.49 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Fri, 23 Oct 2020 07:07:51 -0700 (PDT) Subject: Re: [PATCH v2 07/24] Documentation for memory tagging remote packets To: Eli Zaretskii References: <20201022200014.5189-1-luis.machado@linaro.org> <20201022200014.5189-8-luis.machado@linaro.org> <838sbxlaqv.fsf@gnu.org> Message-ID: <42ae2b44-67de-3860-2e3a-941392cac68a@linaro.org> Date: Fri, 23 Oct 2020 11:07:48 -0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.10.0 MIME-Version: 1.0 In-Reply-To: <838sbxlaqv.fsf@gnu.org> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit 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: Luis Machado via Gdb-patches Reply-To: Luis Machado Cc: david.spickett@linaro.org, gdb-patches@sourceware.org Errors-To: gdb-patches-bounces@sourceware.org Sender: "Gdb-patches" Hi Eli, On 10/23/20 3:25 AM, Eli Zaretskii wrote: >> 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). Thanks for clarifying that. Fixed now. > >> +@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. > Fixed. >> +@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. Yeah. It reads a bit funny. How about the following? @var{type} is the type of tag the request wants to fetch. The type is a signed integer. > >> +tags found in the request memory range. > ^^^^^^^ > "requested" > Oops. Fixed. >> +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{..}. > Fixed. >> +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? > How about the following? NT is the number of memory tags contained in @var{tag bytes}. Only target-specific code can determine this value. For example, AArch64's tags are stored 1 per byte. NG is the number of memory tag granules in the memory range @w{@r{[}@var{start address}, @var{start address} + @var{length}@r{)}}. Only target-specific can determine this value. For example, AArch64 has a tag granule size of 16 bytes. That is, it has one memory for every 16 bytes of memory. >> +@var{type} is the type of tag, a signed integer, the request wants to store. > > Same comment as above regarding ambiguity of the sentence. > Fixed in the same way as above. >> +@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. > I did... "The remote stub supports and implements the required memory tagging functionality and understands the @samp{qMemTags} (@pxref{qMemTags}) and @samp{QMemTags} (@pxref{QMemTags}) packets." And I've added a couple anchors to the packets. Is that what you had in mind?