Re: [PATCH v3] gdb: ADI support

[Weimin Pan <weimin dot pan at oracle dot com>]

Thanks for your comments. I have
 (1) moved the "NEWS" entry from gdb/doc/ChangeLog to gdb/ChangeLog.
 (2) changed gdb.texinfo as follows:

@table @code
@kindex adi examine
@item adi (examine | x) [ / @var{n} ] @var{addr}

The @code{adi examine} command displays the value of one ADI version tag per
cacheline.  It has the following command syntax:

@var{n} is a decimal integer specifying the number in bytes; the default 
is 1.  It specifies how much ADI version information, at the ratio of 1:ADI 
block size, to display.

@var{addr} is the address in user address space where you want @value{GDBN}
to begin displaying the ADI version tags.
...
...

----@kindex adi assign
@item adi (assign | a) [ / @var{n} ] @var{addr} = @var{tag}

The @code{adi assign} command is used to assign new ADI version tag
to an address.  It has the following command syntax:

@var{n} is a decimal integer specifying the number in bytes;
the default is 1.  It specifies how much ADI version information, at the
ratio of 1:ADI block size, to modify.

@var{addr} is the address in user address space where you want @value{GDBN}
to begin modifying the ADI version tags.

@var{tag} is the new ADI version tag.

- Original Message -----
From: eliz@gnu.org
To: weimin.pan@oracle.com
Cc: gdb-patches@sourceware.org
Sent: Tuesday, June 27, 2017 7:36:28 AM GMT -08:00 US/Canada Pacific
Subject: Re: [PATCH v3] gdb: ADI support

> From: Weimin Pan <weimin.pan@oracle.com>
> Date: Mon, 26 Jun 2017 19:12:46 -0500
> 
> gdb/doc/ChangeLog:
> 2017-06-26  Weimin Pan  <weimin.pan@oracle.com>
> 	* gdb.texinfo (Architectures): Add new Sparc64 section to document
> 	ADI support.
> 	* NEWS: Add "adi examine" and "adi assign" commands.

I don't see the NEWS part in the patch.  And NERWS is not in gdb/doc/,
so its ChangeLog entry should be in gdb/ChangeLog.

> +The @code{adi examine} command displays the value of one ADI version tag per 
> +cacheline.  It has the following command syntax: 
> +
> +@table @code
> +@itemx adi (examine | x) [ / @var{n} ] @var{addr}
> +@end table

This should be @example, not @itemx in @table.  Alternatively, put all
the arguments on the previous @item line -- that's how we usually
describe commands in the first place.

> +@var{n}, the byte count
> +The count is a decimal integer specifying the number in bytes; the default 
> +is 1.

The first part should be part of the sentence:

  The count @var{n} is a decimal integer specifying ...

> +@var{addr}, starting display address
> +@var{addr} is the address in user address space where you want @value{GDBN} 
> +to begin displaying the ADI version tags. 

Here the part before the sentence should be simply deleted, as it
isn't needed.

> +@kindex adi assign
> +@item adi assign
> +
> +The @code{adi assign} command is used to assign new ADI version tag 
> +to an address.  It has the following command syntax:
> +
> +@table @code
> +@itemx adi (assign | a) [ / @var{n} ] @var{addr} = @var{tag}
> +@end table
> +
> +@var{n}, the byte count
> +The count is a decimal integer specifying the number in bytes; the default 
> +is 1.  It specifies how much ADI version information, at the ratio of 1:ADI 
> +block size, to modify. 
> +
> +@var{addr}, starting display address
> +@var{addr} is the address in user address space where you want @value{GDBN} 
> +to begin modifying the ADI version tags. 
> +
> +@var{tag}, the new ADI version tag

Same comments to the description of this command.

Thanks.