* serial.h (SERIAL_SET_TTY_STATE): Comment return value.

[deliverable/binutils-gdb.git] / gdb / serial.h

diff --git a/gdb/serial.h b/gdb/serial.h
index ed8b33ae6dc457fd4cdd462c6b23cbfeca8eee4f..9e669cbb2bb1fb0bf6f3f45df3e9fd060e278cee 100644 (file)
--- a/gdb/serial.h
+++ b/gdb/serial.h
@@ -105,7 +105,9 @@ serial_t serial_fdopen PARAMS ((const int fd));
 #define SERIAL_GET_TTY_STATE(SERIAL_T) (SERIAL_T)->ops->get_tty_state((SERIAL_T))
 
 /* Set the state of the tty to TTYSTATE.  The change is immediate.
-   When changing to or from raw mode, input might be discarded.  */
+   When changing to or from raw mode, input might be discarded.
+   Returns 0 for success, negative value for error (in which case errno
+   contains the error).  */
 #define SERIAL_SET_TTY_STATE(SERIAL_T, TTYSTATE) (SERIAL_T)->ops->set_tty_state((SERIAL_T), (TTYSTATE))
 
 /* printf_filtered a user-comprehensible description of ttystate.  */