From 78d181cb3e473c275fe8cef967faf8d0c4b8bed8 Mon Sep 17 00:00:00 2001 From: leitner Date: Sat, 6 Mar 2004 10:27:44 +0000 Subject: [PATCH] document return values correctly --- io/io_fd.3 | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/io/io_fd.3 b/io/io_fd.3 index 5cfa801..787c252 100644 --- a/io/io_fd.3 +++ b/io/io_fd.3 @@ -4,7 +4,7 @@ io_fd \- prepare descriptor for io_wait .SH SYNTAX .B #include -void \fBio_fd\fP(int64 fd); +int \fBio_fd\fP(int64 fd); .SH DESCRIPTION If you want to use io_canread() and io_canwrite() on a descriptor, you have to use io_wait() on it first, and io_wait() has to know which @@ -15,5 +15,7 @@ io_pipe and io_socketpair already call io_fd for you. Waiting on descriptors only works for sockets, fifos and pipes. It may also work on devices and TTYs, but that is platform dependent -- you should not rely on that. It does not work on files. +.SH "RETURN VALUE" +io_fd returns 1 on success, 0 on error. .SH "SEE ALSO" io_wait(3), io_wantread(3), io_canread(3), io_eagain(3), io_nonblock(3)