From 24cf63899bf363c761c344a47dae037fbba8d643 Mon Sep 17 00:00:00 2001 From: Andrew Burgess Date: Thu, 28 Jan 2021 09:58:43 +0000 Subject: [PATCH] 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. --- gdb/ChangeLog | 5 +++++ gdb/gdbcmd.h | 9 ++++++--- gdb/top.c | 4 +--- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/gdb/ChangeLog b/gdb/ChangeLog index f16a4d61be2..46ba66d7c40 100644 --- a/gdb/ChangeLog +++ b/gdb/ChangeLog @@ -1,3 +1,8 @@ +2021-01-28 Andrew Burgess + + * gdbcmd.h (execute_command_to_string): Update comment. + * top.c (execute_command_to_string): Update header comment. + 2021-01-28 Tom de Vries PR breakpoints/27205 diff --git a/gdb/gdbcmd.h b/gdb/gdbcmd.h index af6235f9e17..f541ebd92d2 100644 --- a/gdb/gdbcmd.h +++ b/gdb/gdbcmd.h @@ -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, diff --git a/gdb/top.c b/gdb/top.c index 08c47422514..3be95079654 100644 --- a/gdb/top.c +++ b/gdb/top.c @@ -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, -- 2.30.2