From 8a67c9ff828aa4e669a25b1639d57dd9fab76312 Mon Sep 17 00:00:00 2001
From: Arthur de Jong <arthur@arthurdejong.org>
Date: Sat, 9 Mar 2013 16:19:20 +0100
Subject: fix the description of the tio_time_remaining() function

---
 common/tio.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'common/tio.c')

diff --git a/common/tio.c b/common/tio.c
index 9383733..0039fd1 100644
--- a/common/tio.c
+++ b/common/tio.c
@@ -75,8 +75,9 @@ struct tio_fileinfo {
 #endif /* DEBUG_TIO_STATS */
 };
 
-/* update the timeout to the value that is remaining before deadline
-   returns non-zero if there is no more time before the deadline */
+/* update the timeout to the value that is remaining before the deadline
+   returns the number of milliseconds before the deadline (or a negative
+   value of the deadline has expired) */
 static inline int tio_time_remaining(struct timeval *deadline, int timeout)
 {
   struct timeval tv;
-- 
cgit v1.2.3