[RFA] Allow to document user-defined aliases.

Tom Tromey tom@tromey.com
Thu Aug 4 19:12:19 GMT 2022


>>>>> "Philippe" == Philippe Waroquiers via Gdb-patches <gdb-patches@sourceware.org> writes:

Philippe> When using 'help ALIASNAME', GDB shows the help of the aliased command.
Philippe> This is a good default behaviour.

Philippe> However, GDB alias command allows to define aliases with arguments
Philippe> possibly changing or tuning significantly the behaviour of
Philippe> the aliased command.  In such a case, showing the help of the aliased
Philippe> command might not be ideal.
[...]
Philippe> When a user-defined alias is documented specifically, help and apropos
Philippe> use the provided alias documentation instead of the documentation of
Philippe> the aliased command.

This makes sense to me.  My perspective is that the way a command is
defined (there are 4 or 5 ways now) isn't as important as what it does,
and users are normally interested in the latter.

One question I have is whether there is any way to see how the command
is defined, if it is documented.  For  commands  using "define" there is
"show user-defined"... perhaps that ought to be made to work with
aliases as well.

Tom


More information about the Gdb-patches mailing list