[libvirt] [PATCH 0/2] documentation fixes for virConnectClose and virConnectDomainEventBlockJobCallback

Hi. This series fixes some documentation glitches that broke the build when rejecting missing documentation in apibuild.py. See https://www.redhat.com/archives/libvir-list/2013-January/msg02020.html Claudio Bley (2): libvirt.h.in: add missing documentation for virConnectCloseFunc libvirt.h.in: fix documentation for virConnectDomainEventBlockJobCallback include/libvirt/libvirt.h.in | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) -- 1.7.9.5

Signed-off-by: Claudio Bley <cbley@av-test.de> --- include/libvirt/libvirt.h.in | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/include/libvirt/libvirt.h.in b/include/libvirt/libvirt.h.in index a634b37..c51474e 100644 --- a/include/libvirt/libvirt.h.in +++ b/include/libvirt/libvirt.h.in @@ -1398,6 +1398,15 @@ typedef enum { # endif } virConnectCloseReason; +/** + * virConnectCloseFunc: + * @conn: virConnect connection + * @reason: reason why the connection was close (one of virConnectCloseReason) + * @opaque: opaque user data + * + * A callback function to be registered, and called when the connection + * is closed. + */ typedef void (*virConnectCloseFunc)(virConnectPtr conn, int reason, void *opaque); -- 1.7.9.5

In commit 3ac26e2645e6456389a918455213d7e3824f63f9 parameter "path" was renamed to "disk" but this change was not reflected in the documentation. Additionally, documentation of the "opaque" parameter was missing. Signed-off-by: Claudio Bley <cbley@av-test.de> --- include/libvirt/libvirt.h.in | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/include/libvirt/libvirt.h.in b/include/libvirt/libvirt.h.in index c51474e..c8454b2 100644 --- a/include/libvirt/libvirt.h.in +++ b/include/libvirt/libvirt.h.in @@ -4359,9 +4359,10 @@ typedef enum { * virConnectDomainEventBlockJobCallback: * @conn: connection object * @dom: domain on which the event occurred - * @path: fully-qualified filename of the affected disk + * @disk: fully-qualified filename of the affected disk * @type: type of block job (virDomainBlockJobType) * @status: final status of the operation (virConnectDomainEventBlockJobStatus) + * @opaque: application specified data * * The callback signature to use when registering for an event of type * VIR_DOMAIN_EVENT_ID_BLOCK_JOB with virConnectDomainEventRegisterAny() -- 1.7.9.5

At Wed, 30 Jan 2013 08:49:51 +0100, Claudio Bley wrote:
Hi.
This series fixes some documentation glitches that broke the build when rejecting missing documentation in apibuild.py.
See https://www.redhat.com/archives/libvir-list/2013-January/msg02020.html
Claudio Bley (2): libvirt.h.in: add missing documentation for virConnectCloseFunc libvirt.h.in: fix documentation for virConnectDomainEventBlockJobCallback
Additionally to those changes, I forgot to fix virEventRemoveHandleFunc's return documentation. When reviewing, please also take the following into account: ---- >8 -----
From c538974eb4f24bd9a74ed6314a995852dcd33bf1 Mon Sep 17 00:00:00 2001 From: Claudio Bley <cbley@av-test.de> Date: Wed, 30 Jan 2013 09:25:16 +0100 Subject: [PATCH] libvirt.h.in: add missing return doc for virEventRemoveHandleFunc Organization: AV-Test GmbH, Germany
Signed-off-by: Claudio Bley <cbley@av-test.de> --- include/libvirt/libvirt.h.in | 2 ++ 1 file changed, 2 insertions(+) diff --git a/include/libvirt/libvirt.h.in b/include/libvirt/libvirt.h.in index c8454b2..793d26f 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);

At Wed, 30 Jan 2013 08:49:51 +0100, Claudio Bley wrote:
Hi.
This series fixes some documentation glitches that broke the build when rejecting missing documentation in apibuild.py.
See https://www.redhat.com/archives/libvir-list/2013-January/msg02020.html
Claudio Bley (2): libvirt.h.in: add missing documentation for virConnectCloseFunc libvirt.h.in: fix documentation for virConnectDomainEventBlockJobCallback
I'll integrate these patches into a bigger series, as it was way easier to work that way for me. I guess it makes review easier, also. Claudio -- AV-Test GmbH, Henricistraße 20, 04155 Leipzig, Germany Phone: +49 341 265 310 19 Web:<http://www.av-test.org> Eingetragen am / Registered at: Amtsgericht Stendal (HRB 114076) Geschaeftsfuehrer (CEO): Andreas Marx, Guido Habicht, Maik Morgenstern
participants (1)
-
Claudio Bley