From: Tim Kourt <tim.a.kourt@linux.intel.com>
To: ell@lists.01.org
Subject: [PATCH] timeout: Clearified the ruturn behavior in comments
Date: Thu, 28 Apr 2016 11:21:06 -0700 [thread overview]
Message-ID: <1461867666-37029-1-git-send-email-tim.a.kourt@linux.intel.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 1231 bytes --]
---
ell/timeout.c | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/ell/timeout.c b/ell/timeout.c
index 499c6d6..4ba4e6e 100644
--- a/ell/timeout.c
+++ b/ell/timeout.c
@@ -103,7 +103,8 @@ static inline int timeout_set(int fd, unsigned int seconds, long nanoseconds)
* The timeout will on fire once. The timeout handling needs to be rearmed
* with l_timeout_modify() to trigger again.
*
- * Returns: a newly allocated #l_timeout object
+ * Returns: a newly allocated #l_timeout object. On failure, the function
+ * returns NULL.
**/
LIB_EXPORT struct l_timeout *l_timeout_create(unsigned int seconds,
l_timeout_notify_cb_t callback,
@@ -126,7 +127,8 @@ LIB_EXPORT struct l_timeout *l_timeout_create(unsigned int seconds,
* The timeout will on fire once. The timeout handling needs to be rearmed
* with l_timeout_modify_with_nanoseconds() to trigger again.
*
- * Returns: a newly allocated #l_timeout object
+ * Returns: a newly allocated #l_timeout object. On failure, the function
+ * returns NULL.
**/
LIB_EXPORT struct l_timeout *l_timeout_create_with_nanoseconds(unsigned int seconds,
long nanoseconds, l_timeout_notify_cb_t callback,
--
2.5.0
next reply other threads:[~2016-04-28 18:21 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-04-28 18:21 Tim Kourt [this message]
2016-04-28 18:23 ` [PATCH] timeout: Clearified the ruturn behavior in comments Denis Kenzior
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1461867666-37029-1-git-send-email-tim.a.kourt@linux.intel.com \
--to=tim.a.kourt@linux.intel.com \
--cc=ell@lists.01.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.