diff options
| author | Andrew Burgess <andrew.burgess@embecosm.com> | 2021-01-28 09:58:43 +0000 |
|---|---|---|
| committer | Andrew Burgess <andrew.burgess@embecosm.com> | 2021-01-28 10:04:54 +0000 |
| commit | 24cf63899bf363c761c344a47dae037fbba8d643 (patch) | |
| tree | 562d0a9045fc5fadebd33ee0f57ceb80c403f7f3 /gdb/gdbcmd.h | |
| parent | 2a7f6487d0a2f9a5f16d0f67904ac35100313eb1 (diff) | |
| download | gdb-24cf63899bf363c761c344a47dae037fbba8d643.zip gdb-24cf63899bf363c761c344a47dae037fbba8d643.tar.gz gdb-24cf63899bf363c761c344a47dae037fbba8d643.tar.bz2 | |
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.
Diffstat (limited to 'gdb/gdbcmd.h')
| -rw-r--r-- | gdb/gdbcmd.h | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/gdb/gdbcmd.h b/gdb/gdbcmd.h index af6235f..f541ebd 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, |