This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [PATCH v3 1/4] reggroups: Add test and docs for `info reg $reggroup` feature
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Stafford Horne <shorne at gmail dot com>
- Cc: gdb-patches at sourceware dot org, openrisc at lists dot librecores dot org
- Date: Tue, 19 Dec 2017 18:23:29 +0200
- Subject: Re: [PATCH v3 1/4] reggroups: Add test and docs for `info reg $reggroup` feature
- Authentication-results: sourceware.org; auth=none
- References: <20171219142257.13402-1-shorne@gmail.com> <20171219142257.13402-2-shorne@gmail.com>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> From: Stafford Horne <shorne@gmail.com>
> Cc: Openrisc <openrisc@lists.librecores.org>, Stafford Horne <shorne@gmail.com>
> Date: Tue, 19 Dec 2017 23:22:54 +0900
>
> Until now this feature has existed but was not documented. Adding docs
> and tests.
Thanks!
> +@item info registers @var{reggroup} @dots{}
> +Print the name and value of the registers in each of the specified
> +@var{reggroup}. The @var{reggoup} can be any of those returned by
Please use "@var{reggroup}s", with the trailing "s", otherwise this is
not correct English.
> +@code{maint print reggroups}.
Please add here a cross-reference to the node where "maint print
reggroups" is described.
> c = add_info ("registers", info_registers_command, _("\
> List of integer registers and their contents, for selected stack frame.\n\
> -Register name as argument means describe only that register."));
> +Register name as argument means describe only that register.\n\
> +Register group name as argument means describe the registers in the\n\
> +named register group."));
Since this command accepts more than one reggroup, I think the doc
string should mention that.
The documentation parts are okay with these nits fixed.