From 83bc4fa7fa590540369fb3c01965456aeca5d6b6 Mon Sep 17 00:00:00 2001 From: Tiziano Mueller Date: Sat, 5 Mar 2011 18:36:23 +0100 Subject: [PATCH] update virGetVersion description The current description suggests that you always have to provide a valid typeVer pointer. But if you want only the libvirt version it's also possible to set type and typeVer to NULL to skip the hypervisor part. --- AUTHORS | 1 + src/libvirt.c | 17 +++++++++-------- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/AUTHORS b/AUTHORS index 0e56468c28..3445789fcd 100644 --- a/AUTHORS +++ b/AUTHORS @@ -159,6 +159,7 @@ Patches have also been contributed by: Phil Petty Taku Izumi Minoru Usui + Tiziano Mueller [....send patches to get your name here....] diff --git a/src/libvirt.c b/src/libvirt.c index 33bb17cdd1..e7c4cc554d 100644 --- a/src/libvirt.c +++ b/src/libvirt.c @@ -860,14 +860,15 @@ int virStateActive(void) { /** * virGetVersion: * @libVer: return value for the library version (OUT) - * @type: the type of connection/driver looked at - * @typeVer: return value for the version of the hypervisor (OUT) - * - * Provides two information back, @libVer is the version of the library - * while @typeVer will be the version of the hypervisor type @type against - * which the library was compiled. If @type is NULL, "Xen" is assumed, if - * @type is unknown or not available, an error code will be returned and - * @typeVer will be 0. + * @type: the type of connection/driver looked at, if @typeVer is not NULL + * @typeVer: optional return value for the version of the hypervisor (OUT) + * + * Provides information on up to two versions: @libVer is the version of the + * library and will always be set unless an error occurs, in which case an + * error code will be returned. If @typeVer is not NULL it will be set to the + * version of the hypervisor @type against which the library was compiled. + * If @type is NULL, "Xen" is assumed, if @type is unknown or not + * available, an error code will be returned and @typeVer will be 0. * * Returns -1 in case of failure, 0 otherwise, and values for @libVer and * @typeVer have the format major * 1,000,000 + minor * 1,000 + release. -- 2.39.5