Re: [libvirt] [PATCH] event: improve public API docs
On 01/02/2014 06:15 AM, Martin Kletzander wrote:
On Tue, Dec 31, 2013 at 08:21:29AM -0700, Eric Blake wrote:
> Since libvirt 0.9.3, the entire virevent.c file has been a public
> API, so improve the documentation in this file. Also, fix a
> potential core dump - it could only be triggered by bogus use of
> the API and would only affect the caller (not libvirtd), but we
> might as well be nice.
>
> *
> + * Use of the virEventAddHandle() and similar APIs require that the
> + * corresponding handler be registered. Use of the
> + * virConnectDomainEventRegisterAny() and similar APIs requires that
> + * the three timeout handlers be registered.
s/be/to be/ or s/be/are/ maybe?
I went with s/be/are/
> + * closed unexpectedly as a result of keepalive timeout. The
default
> + * event loop fully supports handle and and timeout events, but only
s/and and/and/
Yeah, 'make syntax-check' is nice :)
ACK, I'll have a look at the fixup in a second.
I've cleaned up according to your suggestions (here, and in the
followup), and pushed.
--
Eric Blake eblake redhat com +1-919-301-3266
Libvirt virtualization library http://libvirt.org
Attachments:
- signature.asc (application/pgp-signature — 604 bytes)