gdb: update comment for execute_command_to_string

The function execute_command_to_string had two header comments, one in
gdbcmd.h and one in top.c.

This commit merges the two comments into one and places this comment
in gdbcmd.h.  The comment in top.c is updated to just reference
gdbcmd.h.

gdb/ChangeLog:

	* gdbcmd.h (execute_command_to_string): Update comment.
	* top.c (execute_command_to_string): Update header comment.
This commit is contained in:
Andrew Burgess 2021-01-28 09:58:43 +00:00
parent 2a7f6487d0
commit 24cf63899b
3 changed files with 12 additions and 6 deletions

View File

@ -1,3 +1,8 @@
2021-01-28 Andrew Burgess <andrew.burgess@embecosm.com>
* gdbcmd.h (execute_command_to_string): Update comment.
* top.c (execute_command_to_string): Update header comment.
2021-01-28 Tom de Vries <tdevries@suse.de>
PR breakpoints/27205

View File

@ -134,9 +134,12 @@ extern struct cmd_list_element *save_cmdlist;
extern void execute_command (const char *, int);
/* Execute command P and returns its output. If TERM_OUT,
the output is built using terminal output behaviour such
as cli_styling. */
/* Run execute_command for P and FROM_TTY. Capture its output into the
returned string, do not display it to the screen. The global BATCH_FLAG
will temporarily be set to true. When TERM_OUT is true the output is
collected with terminal behaviour (e.g. with styling). When TERM_OUT is
false raw output will be collected (e.g. no styling). */
extern std::string execute_command_to_string (const char *p, int from_tty,
bool term_out);
extern void execute_command_to_ui_file (struct ui_file *file,

View File

@ -716,9 +716,7 @@ execute_command_to_ui_file (struct ui_file *file, const char *p, int from_tty)
}
}
/* Run execute_command for P and FROM_TTY. Capture its output into the
returned string, do not display it to the screen. BATCH_FLAG will be
temporarily set to true. */
/* See gdbcmd.h. */
std::string
execute_command_to_string (const char *p, int from_tty,