Re: [PATCH 1/2] Move the code to execute a cmd_list_element out from execute_command

[Andrew Burgess <andrew.burgess@embecosm.com>]

* Marco Barisione <mbarisione@undo.io> [2020-10-05 10:40:19 +0100]:

> On 5 Oct 2020, at 10:08, Andrew Burgess <andrew.burgess@embecosm.com> wrote:
> >> gdb/ChangeLog:
> >> 
> >> 	* gdbcmd.h (execute_cmd_list_command): Add declaration.
> >> 	* top.c (execute_command): Move out the code to execute a
> >> 	command from a cmd_list_element.
> >> 	(execute_cmd_list_command): Add from code originally in
> >> 	execute_command.
> >> 	* top.h (execute_cmd_list_command): Add declaration.
> > 
> > Why is execute_cmd_list_command declared twice?  This doesn't feel
> > right.
> 
> On top of gdbcmd.h there’s this comment:
> /* ***DEPRECATED***  The gdblib files must not be calling/using things in any
>    of the possible command languages.  If necessary, a hook (that may be
>    present or not) must be used and set to the appropriate routine by any
>    command language that cares about it.  If you are having to include this
>    file you are possibly doing things the old way.  This file will dissapear.
>    fnasser@redhat.com    */

I read this a couple of times and it still doesn't really make much
sense to me.

Maybe someone else on the list will jump in to explain what's going on
here, but assuming they don't I think we should ignore that comment
and make sure the new code we add is as sane as possible.

To that end I think we should have a single declaration, probably in
gdbcmd.h (as the new function seems related to handling gdb commands)
then fix the build fallout, I only had to add new includes to 'top.c'
and 'cli/cli-script.c' so it isn't huge.

One reason for this, which I completely forgot to mention in my first
reply, is that functions should be documented in the header file, and
in the source file just say '/* See gdbcmd.h.  */'.  Obviously we
don't want to have functions documented twice at the two declaration
points.

Thanks,
Andrew


> 
> This deprecation notice was added 20 years ago in commit
> <d318976c46b92e4d8640f1310bb7b6b517c8bcf7>.
> I couldn't really work out the details, so I just copied what is currently
> done for execute_command, which is declared in two header files:
>   $ git grep '\bexecute_command\b' -- '*.h'
>   gdbcmd.h:extern void execute_command (const char *, int);
>   top.h:extern void execute_command (const char *, int);
> 
> 
> -- 
> Marco Barisione
>