summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTodd C. Miller <Todd.Miller@courtesan.com>2015-07-23 07:38:53 -0600
committerTodd C. Miller <Todd.Miller@courtesan.com>2015-07-23 07:38:53 -0600
commit9e8d3c3bff3e763c091327ffb596526d9cd65db5 (patch)
treec30888757234c765d76274d49916a66fb763b7c3
parent8b75268808e9432c69a81ae1cff9d0dda2fc1b12 (diff)
downloadsudo-9e8d3c3bff3e763c091327ffb596526d9cd65db5.tar.gz
Document function return values.
-rw-r--r--term.c9
1 files changed, 9 insertions, 0 deletions
diff --git a/term.c b/term.c
index 50880cecd..85a64f0f0 100644
--- a/term.c
+++ b/term.c
@@ -108,6 +108,7 @@ int term_kill;
/*
* Like tcsetattr() but restarts on EINTR.
+ * Returns 0 on success or -1 on failure, setting errno.
*/
static int
tcsetattr_nointr(int fd, int flags, struct termios *tp)
@@ -123,6 +124,7 @@ tcsetattr_nointr(int fd, int flags, struct termios *tp)
/*
* Restore saved terminal settings.
+ * Returns 1 on success or 0 on failure.
*/
int
term_restore(fd, flush)
@@ -140,6 +142,7 @@ term_restore(fd, flush)
/*
* Disable terminal echo.
+ * Returns 1 on success or 0 on failure.
*/
int
term_noecho(fd)
@@ -163,6 +166,7 @@ term_noecho(fd)
/*
* Set terminal to raw mode.
+ * Returns 1 on success or 0 on failure.
*/
int
term_raw(fd, isig)
@@ -191,6 +195,7 @@ term_raw(fd, isig)
/*
* Set terminal to cbreak mode.
+ * Returns 1 on success or 0 on failure.
*/
int
term_cbreak(fd)
@@ -218,6 +223,7 @@ term_cbreak(fd)
/*
* Copy terminal settings from one descriptor to another.
+ * Returns 1 on success or 0 on failure.
*/
int
term_copy(src, dst)
@@ -238,6 +244,7 @@ term_copy(src, dst)
/*
* Set terminal to raw mode.
+ * Returns 1 on success or 0 on failure.
*/
int
term_raw(fd, isig)
@@ -260,6 +267,7 @@ term_raw(fd, isig)
/*
* Set terminal to cbreak mode.
+ * Returns 1 on success or 0 on failure.
*/
int
term_cbreak(fd)
@@ -282,6 +290,7 @@ term_cbreak(fd)
/*
* Copy terminal settings from one descriptor to another.
+ * Returns 1 on success or 0 on failure.
*/
int
term_copy(src, dst)