[rfa:doco] Add ``maint print registers''

[rfa:doco] Add ``maint print registers''

[Andrew Cagney]

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

Hello,

This adds documentation for the commands:
	maint print regiters
	maint print raw-registers
	maint print cooked-registers
One thing I've noticed in the doco is that it refers to cooked but 
cooked is an internal thing explained (or it will be ...) in the 
internals document.

ok?
Andrew

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

Index: doc/ChangeLog
2002-08-09  Andrew Cagney  <cagney@redhat.com>

	* gdb.texinfo (Maintenance Commands): Document "maint print
	registers", "maint print raw-registers" and "maint print
	cooked-registers".

Index: doc/gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.108
diff -u -r1.108 gdb.texinfo
--- doc/gdb.texinfo	9 Aug 2002 16:41:25 -0000	1.108
+++ doc/gdb.texinfo	10 Aug 2002 00:04:08 -0000
@@ -14195,6 +14195,18 @@
 
 @end table
 
+@kindex maint print registers
+@kindex maint print raw-registers
+@kindex maint print cooked-registers
+@item @anchor{maint print registers}maint print registers
+@itemx @anchor{maint print raw-registers}maint print raw-registers
+@itemx @anchor{maint print cooked-registers}maint print cooked-registers
+Print @value{GDBN}'s internal register structure.  @samp{maint print
+raw-registers} includes the raw register cache value while @samp{maint
+print cooked-registers} includes the cooked register value.
+
+Takes an optional file parameter.
+
 @end table
 
 

Re: [rfa:doco] Add ``maint print registers''

[Eli Zaretskii]

> Date: Fri, 09 Aug 2002 20:07:17 -0400
> From: Andrew Cagney <ac131313@ges.redhat.com>
> 
> One thing I've noticed in the doco is that it refers to cooked but 
> cooked is an internal thing explained (or it will be ...) in the 
> internals document.

Perhaps an example of raw and cooked representation will help here.

> ok?

Yes, thanks.

> +@item @anchor{maint print registers}maint print registers

Why did you use @anchor here, if no other parts of the manual have
any @xref's pointing to them?

Re: [rfa:doco] Add ``maint print registers''

[Andrew Cagney]

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

Try this, its better :-)

>> Date: Fri, 09 Aug 2002 20:07:17 -0400
>> From: Andrew Cagney <ac131313@ges.redhat.com>
>> 
>> One thing I've noticed in the doco is that it refers to cooked but 
>> cooked is an internal thing explained (or it will be ...) in the 
>> internals document.
> 
> 
> Perhaps an example of raw and cooked representation will help here.

Hmm, it now states exactly what raw/cooked print and gives the 
reference.  (No, the Node isn't in the gdbint file yet :-)

>> ok?
> 
> 
> Yes, thanks.
> 
> 
>> +@item @anchor{maint print registers}maint print registers
> 
> 
> Why did you use @anchor here, if no other parts of the manual have
> any @xref's pointing to them?
> 

Andrew

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

2002-08-11  Andrew Cagney  <ac131313@redhat.com>

	* gdb.texinfo (Maintenance Commands): Document "maint print
	registers", "maint print raw-registers" and "maint print
	cooked-registers".

Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.110
diff -u -r1.110 gdb.texinfo
--- gdb.texinfo	10 Aug 2002 00:40:40 -0000	1.110
+++ gdb.texinfo	11 Aug 2002 16:34:46 -0000
@@ -14195,6 +14195,21 @@
 
 @end table
 
+@kindex maint print registers
+@kindex maint print raw-registers
+@kindex maint print cooked-registers
+@item maint print registers
+@itemx maint print raw-registers
+@itemx maint print cooked-registers
+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}.
+
+Takes an optional file parameter.
+
 @end table
 
 

Re: [rfa:doco] Add ``maint print registers''

[Eli Zaretskii]

> Date: Sun, 11 Aug 2002 12:40:44 -0400
> From: Andrew Cagney <ac131313@ges.redhat.com>
> > 
> > Perhaps an example of raw and cooked representation will help here.
> 
> Hmm, it now states exactly what raw/cooked print and gives the 
> reference.

Yes, but the internals manual might not be installed.

Otherwise, no objections to this version.

Re: [rfa:doco] Add ``maint print registers''

[Andrew Cagney]

> Date: Sun, 11 Aug 2002 12:40:44 -0400
>> From: Andrew Cagney <ac131313@ges.redhat.com>
> 
>> > 
>> > Perhaps an example of raw and cooked representation will help here.
> 
>> 
>> Hmm, it now states exactly what raw/cooked print and gives the 
>> reference.
> 
> 
> Yes, but the internals manual might not be installed.

True, I think we should install both (but I've a fuzzy memory that we 
currently don't install either for ``make install'' :-( ).

> Otherwise, no objections to this version.

Ok.

Andrew

Re: [rfa:doco] Add ``maint print registers''

[Eli Zaretskii]

> Date: Tue, 13 Aug 2002 17:33:02 -0400
> From: Andrew Cagney <ac131313@ges.redhat.com>
> > 
> > Yes, but the internals manual might not be installed.
> 
> True, I think we should install both (but I've a fuzzy memory that we 
> currently don't install either for ``make install'' :-( ).

That's true: users must say "make install-info" to get all the manuals
installed.