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.

diff --git a/AUTHORS b/AUTHORS
index 0e56468c28f93845704b1e86f0272107bf7855e3..3445789fcd9e853af2c8649956e9415dd4783ca7 100644 (file)
--- a/AUTHORS
+++ b/AUTHORS
@@ -159,6 +159,7 @@ Patches have also been contributed by:
   Phil Petty           <phpetty@cisco.com>
   Taku Izumi           <izumi.taku@jp.fujitsu.com>
   Minoru Usui          <usui@mxm.nes.nec.co.jp>
+  Tiziano Mueller      <dev-zero@gentoo.org>
 
   [....send patches to get your name here....]
 

diff --git a/src/libvirt.c b/src/libvirt.c
index 33bb17cdd126dcdaea095b6952ff3da44c464069..e7c4cc554d90efd0f46b513d04e01b0e3fe741ef 100644 (file)
--- 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.