Minor comment updates in utils.h

This patch updates some comments in utils.h to more closely reflect
the new reality.
This commit is contained in:
Tom Tromey 2022-01-02 13:59:56 -07:00
parent 179d59a3ee
commit 6b0c115423

View file

@ -193,11 +193,8 @@ extern struct ui_file **current_ui_gdb_stdin_ptr (void);
extern struct ui_file **current_ui_gdb_stderr_ptr (void); extern struct ui_file **current_ui_gdb_stderr_ptr (void);
extern struct ui_file **current_ui_gdb_stdlog_ptr (void); extern struct ui_file **current_ui_gdb_stdlog_ptr (void);
/* Flush STREAM. This is a wrapper for ui_file_flush that also /* Flush STREAM. */
flushes any output pending from uses of the *_filtered output extern void gdb_flush (struct ui_file *stream);
functions; that output is kept in a special buffer so that
pagination and styling are handled properly. */
extern void gdb_flush (struct ui_file *);
/* The current top level's ui_file streams. */ /* The current top level's ui_file streams. */
@ -205,20 +202,16 @@ extern void gdb_flush (struct ui_file *);
#define gdb_stdout (*current_ui_gdb_stdout_ptr ()) #define gdb_stdout (*current_ui_gdb_stdout_ptr ())
/* Input stream */ /* Input stream */
#define gdb_stdin (*current_ui_gdb_stdin_ptr ()) #define gdb_stdin (*current_ui_gdb_stdin_ptr ())
/* Serious error notifications */ /* Serious error notifications. This bypasses the pager, if one is in
use. */
#define gdb_stderr (*current_ui_gdb_stderr_ptr ()) #define gdb_stderr (*current_ui_gdb_stderr_ptr ())
/* Log/debug/trace messages that should bypass normal stdout/stderr /* Log/debug/trace messages that bypasses the pager, if one is in
filtering. For moment, always call this stream using use. */
*_unfiltered. In the very near future that restriction shall be
removed - either call shall be unfiltered. (cagney 1999-06-13). */
#define gdb_stdlog (*current_ui_gdb_stdlog_ptr ()) #define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
/* Truly global ui_file streams. These are all defined in main.c. */ /* Truly global ui_file streams. These are all defined in main.c. */
/* Target output that should bypass normal stdout/stderr filtering. /* Target output that should bypass the pager, if one is in use. */
For moment, always call this stream using *_unfiltered. In the
very near future that restriction shall be removed - either call
shall be unfiltered. (cagney 1999-07-02). */
extern struct ui_file *gdb_stdtarg; extern struct ui_file *gdb_stdtarg;
extern struct ui_file *gdb_stdtargerr; extern struct ui_file *gdb_stdtargerr;
extern struct ui_file *gdb_stdtargin; extern struct ui_file *gdb_stdtargin;
@ -227,11 +220,7 @@ extern struct ui_file *gdb_stdtargin;
extern void set_screen_width_and_height (int width, int height); extern void set_screen_width_and_height (int width, int height);
/* More generic printf like operations. Filtered versions may return /* Generic stdio-like operations. */
non-locally on error. As an extension over plain printf, these
support some GDB-specific format specifiers. Particularly useful
here are the styling formatters: '%p[', '%p]' and '%ps'. See
ui_out::message for details. */
extern void gdb_puts (const char *, struct ui_file *); extern void gdb_puts (const char *, struct ui_file *);
@ -243,6 +232,11 @@ extern void gdb_puts (const char *);
extern void puts_tabular (char *string, int width, int right); extern void puts_tabular (char *string, int width, int right);
/* Generic printf-like operations. As an extension over plain
printf, these support some GDB-specific format specifiers.
Particularly useful here are the styling formatters: '%p[', '%p]'
and '%ps'. See ui_out::message for details. */
extern void gdb_vprintf (const char *, va_list) ATTRIBUTE_PRINTF (1, 0); extern void gdb_vprintf (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
extern void gdb_vprintf (struct ui_file *, const char *, va_list) extern void gdb_vprintf (struct ui_file *, const char *, va_list)