Re: [RFAv2] Allow to document user-defined aliases.

[Eli Zaretskii via Gdb-patches <gdb-patches@sourceware.org>]

> Date: Mon,  8 Aug 2022 21:40:18 +0200
> From: Philippe Waroquiers via Gdb-patches <gdb-patches@sourceware.org>
> 
>  gdb/NEWS                        | 10 ++++++
>  gdb/cli/cli-decode.c            | 59 ++++++++++++++++++++++++---------
>  gdb/cli/cli-script.c            | 41 ++++++++++++++---------
>  gdb/doc/gdb.texinfo             | 26 ++++++++++++++-
>  gdb/testsuite/gdb.base/help.exp | 44 ++++++++++++++++++++++--
>  5 files changed, 146 insertions(+), 34 deletions(-)

Thanks.

> diff --git a/gdb/NEWS b/gdb/NEWS
> index 8c837df76e5..1b74e0fc1bd 100644
> --- a/gdb/NEWS
> +++ b/gdb/NEWS
> @@ -93,6 +93,16 @@ show style disassembler symbol
>  
>  * Changed commands
>  
> +document user-defined
> +  It is now possible to document user-defined aliases.
> +  When a user-defined alias is documented, the help and apropos commands
> +  use the provided documentation instead of the documentation of the
> +  aliased command.
> +  Documenting a user-defined alias is particularly useful when the alias
> +  is a set of nested 'with' commands to avoid showing the help of
> +  the with command for an alias that will in fact launch the
> +  last command given in the nested commands.
> +

This part is OK.

> +A user-defined alias can optionally be documented using the @code{document} command
> +(@pxref{Define, document}).
> +@value{GDBN} then considers this alias as different of the aliased
> +command:

"different from the aliased command", not "different of".

> this alias is not listed in the aliased command help output and asking
                                                             ^
A comma missing there.

> +help for this alias will show the user provided alias documentation
> +instead of

"will show the documentation provided for the alias instead of..."

The documentation parts are OK with these nits fixed.