From: Tobias Ulmer <tu@emlix.com>
Date: Fri, 15 Nov 2013 12:09:15 +0000 (+0100)
Subject: Correct e2lib.poll() documentation
X-Git-Tag: e2factory-2.3.15rc1~383
X-Git-Url: https://git.e2factory.org/?a=commitdiff_plain;h=2a5ff203eb12a76dbf1106b74037fc26cfba2e8e;p=e2factory.git

Correct e2lib.poll() documentation

Signed-off-by: Tobias Ulmer <tu@emlix.com>
---

diff --git a/generic/e2lib.lua b/generic/e2lib.lua
index 230ecf8..bc3847c 100644
--- a/generic/e2lib.lua
+++ b/generic/e2lib.lua
@@ -213,8 +213,9 @@ end
 -- Only indicates first selected file descriptor.
 -- @param timeout Timeout in milliseconds (number).
 -- @param fdvec Vector of file descriptors (table of numbers).
--- @return Returns 0 on timeout, < 0 on error and > 0 to indicate which file
---         descriptor triggered.
+-- @return Returns 0 on timeout, < 0 on error and > 0 for the position in fdvec
+-- that has an event waiting.
+
 -- @return True if it's a POLLIN event.
 -- @return True if it's a POLLOUT event.
 function e2lib.poll(timeout, fdvec)