[libvirt] [PATCH v3 03/13] libvirt.h.in: add missing return doc for virEventRemoveHandleFunc

[Eric Blake]

On 01/30/2013 08:38 AM, Claudio Bley wrote:
> 
> Signed-off-by: Claudio Bley <cbley at av-test.de>
> ---
>  include/libvirt/libvirt.h.in |    2 ++
>  1 file changed, 2 insertions(+)

ACK.  I had to go hunting for where this callback was used, but this
matches the documentation of util/virevent.c:virEventRemoveHandle()
which uses this typedef as a callback.

> 
> diff --git a/include/libvirt/libvirt.h.in b/include/libvirt/libvirt.h.in
> index 08eab47..4222fe1 100644
> --- a/include/libvirt/libvirt.h.in
> +++ b/include/libvirt/libvirt.h.in
> @@ -3533,6 +3533,8 @@ typedef void (*virEventUpdateHandleFunc)(int watch, int event);
>   * If a virEventHandleFreeFunc was supplied when the handle was
>   * registered, it will be invoked some time during, or after this
>   * function call, when it is safe to release the user data.
> + *
> + * Returns -1 if the file handle was not registered, 0 upon success
>   */
>  typedef int (*virEventRemoveHandleFunc)(int watch);
>  
> 

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 621 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20130131/cea3c612/attachment-0001.sig>