Re: [PATCH v3 7/7] gdb: Document qMemTagCheckAddr packet

[Eli Zaretskii <eliz@gnu.org>]

> From: Gustavo Romero <gustavo.romero@linaro.org>
> Cc: luis.machado@arm.com, thiago.bauermann@linaro.org,
>  gustavo.romero@linaro.org
> Date: Thu,  4 Apr 2024 06:48:19 +0000
> 
> This commit documents the 'qMemTagCheckAddr' packet and the associated
> feature 'memory-tagging-check-addr' that informs if this packet is
> supported by the target.
> 
> Signed-off-by: Gustavo Romero <gustavo.romero@linaro.org>
> ---
>  gdb/NEWS            |  9 ++++++++
>  gdb/doc/gdb.texinfo | 50 ++++++++++++++++++++++++++++++++++++++++++---
>  2 files changed, 56 insertions(+), 3 deletions(-)

Thanks.

> diff --git a/gdb/NEWS b/gdb/NEWS
> index feb3a37393a..1158715f41c 100644
> --- a/gdb/NEWS
> +++ b/gdb/NEWS
> @@ -192,6 +192,15 @@ QThreadOptions in qSupported
>    QThreadOptions packet, and the qSupported response can contain the
>    set of thread options the remote stub supports.
>  
> +qMemTagCheckAddr
> +  This new packet allows GDB to query the stub about a given address to check if
> +  it is tagged or not. Many memory tagging-related GDB commands need to perform
> +  this check before they read/write the allocation tag related to an address.
> +  Currently, however, this is done through a 'vFile' request to read the file
> +  /proc/<PID>/smaps and check if the address is in a region reported as memory
> +  tagged. Since not all targets have a notion of what the smaps file is about,
> +  this new packet provides a more generic way to perform such a check.

Please reformat this text so that each line is shorter than 78
columns.  Also, please leave two spaces between sentences, per our
conventions.

> +@item qMemTagCheckAddr:@var{address}
> +@anchor {qMemTagCheckAddr}
> +@cindex check if a given address is in a memory tagged region.
> +@cindex @samp{qMemTagCheckAddr} packet
> +Check if address @var{address} is in a memory tagged region; if it is, it's said
> +to be tagged.  The target is responsible for checking it, as this is
> +architecture-specific.

Likewise here: please make the lines shorter.

Also, the @cindex lines should come _before_ the @item line, not after
it, so that the index entry records the location before the @item.

> +Reply:
> +@table @samp
> +Replies are in a 2 hex digits format.

This should be before @table, like this:

  Replies to this packet should all be in two hex digit format, as
  follows:

  @item @var{01}

> +stub. Access to the @file{/proc/@var{pid}/smaps} file is done via @samp{vFile}
       ^^
Two spaces between sentences, please.

Reviewed-By: Eli Zaretskii <eliz@gnu.org>