Improve documentation of readv_nonblock().
authorAndre Noll <maan@systemlinux.org>
Mon, 18 Mar 2013 19:22:31 +0000 (20:22 +0100)
committerAndre Noll <maan@systemlinux.org>
Mon, 18 Mar 2013 19:22:31 +0000 (20:22 +0100)
Define the meaning of "sz".

fd.c

diff --git a/fd.c b/fd.c
index 3a8406d..133f5d3 100644 (file)
--- a/fd.c
+++ b/fd.c
@@ -162,9 +162,9 @@ __printf_2_3 int write_va_buffer(int fd, const char *fmt, ...)
  *
  * If \a rfds is not \p NULL and the (non-blocking) file descriptor \a fd is
  * not set in \a rfds, this function returns early without doing anything.
- * Otherwise The function tries to read up to \a sz bytes from \a fd. As for
- * xwrite(), EAGAIN is not considered an error condition. However, EOF
- * is.
+ * Otherwise The function tries to read up to \a sz bytes from \a fd, where \a
+ * sz is the sum of the lengths of all vectors in \a iov. As for xwrite(),
+ * \p EAGAIN is not considered an error condition. However, \p EOF is.
  *
  * \return Zero or a negative error code. If the underlying call to readv(2)
  * returned zero (indicating an end of file condition) or failed for some