Re: [patch/rfc; rfa:doco] Add reggroups and their maint commands

[Andrew Cagney <ac131313@redhat.com>]

[-- Attachment #1: Type: text/plain, Size: 682 bytes --]

> On Tue, 22 Oct 2002, Andrew Cagney wrote:

(yes, october)

> 
>> Eli, now does the revised doco look?
> 
> 
> Okay, but I have a couple of comments:
> 
> 
>> +the raw register cache; the command @samp{maint print cooked-registers}
> 
> 
> Don't we use @code for command names in the user manual?

Looks like both are used :-(  Regardless, I've changed it to @code.

>> +@table @samp
>> +@item float_reggroup
> 
> 
> I think @table @code is better here (the quotes produced by @samp in 
> print are redundant).

done.

> Also, I suggest a "@cindex register groups" in gdbint.texinfo where you 
> describe the related functions.

yes.

I've committed the attached.

thanks,
Andrew


[-- Attachment #2: diffs --]
[-- Type: text/plain, Size: 3261 bytes --]

2003-01-29  Andrew Cagney  <ac131313@redhat.com>

	* gdb.texinfo (Maintenance Commands): Document `maint print
	reggroups' and `maint print register-groups'.
	* gdbint.texinfo (Target Architecture Definition): Document
	register_reggroup_p.

Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.142
diff -u -r1.142 gdb.texinfo
--- gdb.texinfo	23 Jan 2003 23:03:32 -0000	1.142
+++ gdb.texinfo	29 Jan 2003 16:10:21 -0000
@@ -14631,17 +14631,39 @@
 @kindex maint print registers
 @kindex maint print raw-registers
 @kindex maint print cooked-registers
+@kindex maint print register-groups
 @item maint print registers
 @itemx maint print raw-registers
 @itemx maint print cooked-registers
+@itemx maint print register-groups
 Print @value{GDBN}'s internal register data structures.
 
-The command @samp{maint print raw-registers} includes the contents of
-the raw register cache; and the command @samp{maint print
-cooked-registers} includes the (cooked) value of all registers.
-@xref{Registers,, Registers, gdbint, @value{GDBN} Internals}.
+The command @code{maint print raw-registers} includes the contents of
+the raw register cache; the command @code{maint print cooked-registers}
+includes the (cooked) value of all registers; and the command
+@code{maint print register-groups} includes the groups that each
+register is a member of.  @xref{Registers,, Registers, gdbint,
+@value{GDBN} Internals}.
 
 Takes an optional file parameter.
+
+@kindex maint print reggroups
+@item maint print reggroups
+Print @value{GDBN}'s internal register group data structures.
+
+Takes an optional file parameter.
+
+@smallexample
+(gdb) @kbd{maint print reggroups}
+ Group      Type      
+ general    user      
+ float      user      
+ all        user      
+ vector     user      
+ system     user      
+ save       internal  
+ restore    internal  
+@end smallexample
 
 @kindex maint set profile
 @kindex maint show profile
Index: gdbint.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdbint.texinfo,v
retrieving revision 1.119
diff -u -r1.119 gdbint.texinfo
--- gdbint.texinfo	15 Jan 2003 19:35:28 -0000	1.119
+++ gdbint.texinfo	29 Jan 2003 16:10:21 -0000
@@ -3510,6 +3510,28 @@
 virtual type.
 @xref{Target Architecture Definition, , Raw and Virtual Register Representations}.
 
+@item register_reggroup_p (@var{gdbarch}, @var{regnum}, @var{reggroup})
+@findex register_reggroup_p
+@cindex register groups
+Return non-zero if register @var{regnum} is a member of the register
+group @var{reggroup}.
+
+By default, registers are grouped as follows:
+
+@table @code
+@item float_reggroup
+Any register with a valid name and a floating-point type.
+@item vector_reggroup
+Any register with a valid name and a vector type.
+@item general_reggroup
+Any register with a valid name and a type other than vector or
+floating-point.  @samp{float_reggroup}.
+@item save_reggroup
+@itemx restore_reggroup
+@itemx all_reggroup
+Any register with a valid name.
+@end table
+
 @item REGISTER_VIRTUAL_SIZE (@var{reg})
 @findex REGISTER_VIRTUAL_SIZE
 Return the virtual size of @var{reg}; defaults to the size of the