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.

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index f16a4d61be297f4f955071f549daa84506039028..46ba66d7c402c29ca6a1e14cd6a5b06ce62ec8a3 100644 (file)
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -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

diff --git a/gdb/gdbcmd.h b/gdb/gdbcmd.h
index af6235f9e17804a064cb2850167a221c25d02694..f541ebd92d2a4f443c0c6d8d44f8e1948e4adec0 100644 (file)
--- 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 08c4742251467380a2120943adc0dc413eaa7f57..3be950796545e206dad1fcf3c9184f3c9e855c24 100644 (file)
--- 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,