[libvirt] [PATCH] update virGetVersion description

[Eric Blake]

On 03/05/2011 10:36 AM, Tiziano Mueller wrote:
> 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.
> ---
>  src/libvirt.c |   11 ++++++-----
>  1 files changed, 6 insertions(+), 5 deletions(-)

Thanks for the patch.  I made a couple further tweaks, and pushed.

> 
> diff --git a/src/libvirt.c b/src/libvirt.c
> index e4b451e..a8b48ea 100644
> --- a/src/libvirt.c
> +++ b/src/libvirt.c
> @@ -863,11 +863,12 @@ int virStateActive(void) {
>   * @type: the type of connection/driver looked at

I added "if @typeVer is not NULL"

>   * @typeVer: return value for the version of the hypervisor (OUT)

I added "optional" here

>   *
> - * 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.
> + * Provides two information back: @libVer is the version of the library

s/two information back/information on up to two versions/

> + * 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.
>   *

Plus I listed you in AUTHORS; let me know if you prefer any alternate
spelling.

-- 
Eric Blake   eblake at redhat.com    +1-801-349-2682
Libvirt virtualization library http://libvirt.org

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