[RFA]: Document tui reg commands

[RFA]: Document tui reg commands

[Stephane Carrez]

[-- Attachment #1.1: Type: text/plain, Size: 201 bytes --]

Hi!

This is the documentation part of the new TUI reg commands.

Ok to commit?

	Stephane

2004-03-13  Stephane Carrez  <stcarrez@nerim.fr>

	* gdb.texinfo (TUI Commands): Document tui reg commands.


[-- Attachment #1.2: doc.diffs --]
[-- Type: text/plain, Size: 1086 bytes --]

Index: doc/gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.200
diff -u -p -r1.200 gdb.texinfo
--- doc/gdb.texinfo	9 Mar 2004 16:16:35 -0000	1.200
+++ doc/gdb.texinfo	13 Mar 2004 13:24:43 -0000
@@ -14232,6 +14232,25 @@ can be affected to another window.
 @item refresh
 @kindex refresh
 Refresh the screen.  This is similar to using @key{C-L} key.
+
+@item tui reg float
+@kindex tui reg float
+Show the floating point registers in the register window.
+
+@item tui reg general
+@kindex tui reg general
+Show the general registers in the register window.
+
+@item tui reg next
+@kindex tui reg next
+Show the next register group.  The list of register groups as well as
+their order is target specific.  The predefined register groups are the
+following: @code{general}, @code{float}, @code{system}, @code{vector},
+@code{all}, @code{save}, @code{restore}.
+
+@item tui reg system
+@kindex tui reg system
+Show the system registers in the register window.
 
 @item update
 @kindex update

[-- Attachment #2: Type: application/pgp-signature, Size: 253 bytes --]

[RFA]: Document tui reg commands

[Stephane Carrez]

[-- Attachment #1.1: Type: text/plain, Size: 201 bytes --]

Hi!

This is the documentation part of the new TUI reg commands.

Ok to commit?

	Stephane

2004-03-13  Stephane Carrez  <stcarrez@nerim.fr>

	* gdb.texinfo (TUI Commands): Document tui reg commands.


[-- Attachment #1.2: doc.diffs --]
[-- Type: text/plain, Size: 1086 bytes --]

Index: doc/gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.200
diff -u -p -r1.200 gdb.texinfo
--- doc/gdb.texinfo	9 Mar 2004 16:16:35 -0000	1.200
+++ doc/gdb.texinfo	13 Mar 2004 13:24:43 -0000
@@ -14232,6 +14232,25 @@ can be affected to another window.
 @item refresh
 @kindex refresh
 Refresh the screen.  This is similar to using @key{C-L} key.
+
+@item tui reg float
+@kindex tui reg float
+Show the floating point registers in the register window.
+
+@item tui reg general
+@kindex tui reg general
+Show the general registers in the register window.
+
+@item tui reg next
+@kindex tui reg next
+Show the next register group.  The list of register groups as well as
+their order is target specific.  The predefined register groups are the
+following: @code{general}, @code{float}, @code{system}, @code{vector},
+@code{all}, @code{save}, @code{restore}.
+
+@item tui reg system
+@kindex tui reg system
+Show the system registers in the register window.
 
 @item update
 @kindex update

[-- Attachment #2: Type: application/pgp-signature, Size: 253 bytes --]

Re: [RFA]: Document tui reg commands

[Eli Zaretskii]

> Date: Sat, 13 Mar 2004 15:21:50 +0100
> From: Stephane Carrez <stcarrez@nerim.fr>
> 
> This is the documentation part of the new TUI reg commands.

Thanks.

> Ok to commit?

Yes, but please fix the following small gotchas:

> +@item tui reg float
> +@kindex tui reg float
> +Show the floating point registers in the register window.
> +
> +@item tui reg general
> +@kindex tui reg general
> +Show the general registers in the register window.
> +
> +@item tui reg next
> +@kindex tui reg next

There's no need to make a @kindex entry for all the 3 variants of this
command; a single "@kindex tui reg" will do.  In general, it's not
useful to have several index entries that all begin with the same
string and all point to the same page, because that doesn't add any
information to someone who is looking through the index.

> + [...]  The predefined register groups are the
> +following: @code{general}, @code{float}, @code{system}, @code{vector},
> +@code{all}, @code{save}, @code{restore}.
> +
> +@item tui reg system
> +@kindex tui reg system
> +Show the system registers in the register window.

I think we should have a description of at least some of these
predefined register groups.  For example, I could probably easily
guess what "reg float" or "reg vector" mean, but I have no idea about
"reg system" or "reg save/restore".  I'm afraid a description such as
"Show the system registers in the register window." doesn't help me to
unlock this mystery.

Re: [RFA]: Document tui reg commands

[Eli Zaretskii]

> Date: Sat, 13 Mar 2004 15:21:50 +0100
> From: Stephane Carrez <stcarrez@nerim.fr>
> 
> This is the documentation part of the new TUI reg commands.

Thanks.

> Ok to commit?

Yes, but please fix the following small gotchas:

> +@item tui reg float
> +@kindex tui reg float
> +Show the floating point registers in the register window.
> +
> +@item tui reg general
> +@kindex tui reg general
> +Show the general registers in the register window.
> +
> +@item tui reg next
> +@kindex tui reg next

There's no need to make a @kindex entry for all the 3 variants of this
command; a single "@kindex tui reg" will do.  In general, it's not
useful to have several index entries that all begin with the same
string and all point to the same page, because that doesn't add any
information to someone who is looking through the index.

> + [...]  The predefined register groups are the
> +following: @code{general}, @code{float}, @code{system}, @code{vector},
> +@code{all}, @code{save}, @code{restore}.
> +
> +@item tui reg system
> +@kindex tui reg system
> +Show the system registers in the register window.

I think we should have a description of at least some of these
predefined register groups.  For example, I could probably easily
guess what "reg float" or "reg vector" mean, but I have no idea about
"reg system" or "reg save/restore".  I'm afraid a description such as
"Show the system registers in the register window." doesn't help me to
unlock this mystery.

Re: [RFA]: Document tui reg commands

[Stephane Carrez]

[-- Attachment #1.1: Type: text/plain, Size: 2080 bytes --]

Hi!

Eli Zaretskii wrote:
>>Date: Sat, 13 Mar 2004 15:21:50 +0100
>>From: Stephane Carrez <stcarrez@nerim.fr>
>>
>>This is the documentation part of the new TUI reg commands.
> 
> 
> Thanks.
> 
> 
>>Ok to commit?
> 
> 
> Yes, but please fix the following small gotchas:
> 
> 
>>+@item tui reg float
>>+@kindex tui reg float
>>+Show the floating point registers in the register window.
>>+
>>+@item tui reg general
>>+@kindex tui reg general
>>+Show the general registers in the register window.
>>+
>>+@item tui reg next
>>+@kindex tui reg next
> 
> 
> There's no need to make a @kindex entry for all the 3 variants of this
> command; a single "@kindex tui reg" will do.  In general, it's not
> useful to have several index entries that all begin with the same
> string and all point to the same page, because that doesn't add any
> information to someone who is looking through the index.
> 

Ok.  I've committed the attached patch in 6_1 and main.

> 
>>+ [...]  The predefined register groups are the
>>+following: @code{general}, @code{float}, @code{system}, @code{vector},
>>+@code{all}, @code{save}, @code{restore}.
>>+
>>+@item tui reg system
>>+@kindex tui reg system
>>+Show the system registers in the register window.
> 
> 
> I think we should have a description of at least some of these
> predefined register groups.  For example, I could probably easily
> guess what "reg float" or "reg vector" mean, but I have no idea about
> "reg system" or "reg save/restore".  I'm afraid a description such as
> "Show the system registers in the register window." doesn't help me to
> unlock this mystery.
> 

I agree.  The semantics of 'system' is unclear to me.  For 'save/restore'
may be the TUI should skip them silently as they are related to gdb internals
(registers that are saved/restored by gdb when it calls inferior functions).

 From my point of view, if these groups should ever be documented, they should
be documented outside of the TUI chapter (but today this is the only place
'register group' is mentionned...; apart from mainainters commands...)

   Stephane

[-- Attachment #1.2: gdb.texinfo.diffs --]
[-- Type: text/plain, Size: 998 bytes --]

Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.201
diff -u -p -r1.201 gdb.texinfo
--- gdb.texinfo	26 Mar 2004 16:15:57 -0000	1.201
+++ gdb.texinfo	28 Mar 2004 12:21:22 -0000
@@ -14236,6 +14236,22 @@ can be affected to another window.
 @item refresh
 @kindex refresh
 Refresh the screen.  This is similar to using @key{C-L} key.
+
+@item tui reg float
+@kindex tui reg
+Show the floating point registers in the register window.
+
+@item tui reg general
+Show the general registers in the register window.
+
+@item tui reg next
+Show the next register group.  The list of register groups as well as
+their order is target specific.  The predefined register groups are the
+following: @code{general}, @code{float}, @code{system}, @code{vector},
+@code{all}, @code{save}, @code{restore}.
+
+@item tui reg system
+Show the system registers in the register window.
 
 @item update
 @kindex update

[-- Attachment #2: Type: application/pgp-signature, Size: 253 bytes --]

Re: [RFA]: Document tui reg commands

[Eli Zaretskii]

> 
> I agree.  The semantics of 'system' is unclear to me.  For 'save/restore'
> may be the TUI should skip them silently as they are related to gdb internals
> (registers that are saved/restored by gdb when it calls inferior functions).
> 
>  From my point of view, if these groups should ever be documented, they should
> be documented outside of the TUI chapter (but today this is the only place
> 'register group' is mentionned...; apart from mainainters commands...)

Agreed.

Can someone please donate a description of these register groups?