From b8e4644d1ab65a8ea86d85b4a9cd7dd2c4c4ebdb Mon Sep 17 00:00:00 2001 From: Jonathan Lebon Date: Wed, 18 Sep 2013 14:56:01 -0400 Subject: [PATCH] docs: fix virEventAddHandle return details In commit 6d41cb8, the interface for virEventAddHandleFunc was changed. This patch updates the documentation for virEventAddHandle to reflect the new significance of the return value. Also, both functions now mention -1 for failure. --- include/libvirt/libvirt.h.in | 4 ++-- src/util/virevent.c | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/include/libvirt/libvirt.h.in b/include/libvirt/libvirt.h.in index a47e33cc73..7944dfb607 100644 --- a/include/libvirt/libvirt.h.in +++ b/include/libvirt/libvirt.h.in @@ -3643,8 +3643,8 @@ typedef void (*virEventHandleCallback)(int watch, int fd, int events, void *opaq * If 'ff' callbacks are invoked directly from the virEventRemoveHandleFunc * they will likely deadlock in libvirt. * - * Returns a handle watch number to be used for updating - * and unregistering for events + * Returns -1 if the file handle cannot be registered, otherwise a handle + * watch number to be used for updating and unregistering for events */ typedef int (*virEventAddHandleFunc)(int fd, int event, virEventHandleCallback cb, diff --git a/src/util/virevent.c b/src/util/virevent.c index 886cb6d305..fde29a2be1 100644 --- a/src/util/virevent.c +++ b/src/util/virevent.c @@ -48,7 +48,8 @@ static virEventRemoveTimeoutFunc removeTimeoutImpl = NULL; * * Register a callback for monitoring file handle events. * - * Returns -1 if the file handle cannot be registered, 0 upon success + * Returns -1 if the file handle cannot be registered, otherwise a handle + * watch number to be used for updating and unregistering for events */ int virEventAddHandle(int fd, -- 2.47.2