Re: [RFA]: Document tui reg commands

["Eli Zaretskii" <eliz@elta.co.il>]

> 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.