[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[Libvir] [PATCH] Correct documentation for virConnectOpen*




Simple patch to fix the currently incorrect documentation for these two functions.

Rich.

--
Emerging Technologies, Red Hat - http://et.redhat.com/~rjones/
Registered Address: Red Hat UK Ltd, Amberley Place, 107-111 Peascod
Street, Windsor, Berkshire, SL4 1TE, United Kingdom.  Registered in
England and Wales under Company Registration No. 03798903
--- src/libvirt.c.orig	2007-06-20 15:01:27.000000000 +0100
+++ src/libvirt.c	2007-06-20 15:01:57.000000000 +0100
@@ -345,12 +345,14 @@
 
 /**
  * virConnectOpen:
- * @name: optional argument currently unused, pass NULL
+ * @name: URI of the hypervisor
  *
  * This function should be called first to get a connection to the 
  * Hypervisor and xen store
  *
  * Returns a pointer to the hypervisor connection or NULL in case of error
+ *
+ * URIs are documented at http://libvirt.org/uri.html
  */
 virConnectPtr
 virConnectOpen (const char *name)
@@ -360,13 +362,15 @@
 
 /**
  * virConnectOpenReadOnly:
- * @name: optional argument currently unused, pass NULL
+ * @name: URI of the hypervisor
  *
  * This function should be called first to get a restricted connection to the 
  * libbrary functionalities. The set of APIs usable are then restricted
  * on the available methods to control the domains.
  *
  * Returns a pointer to the hypervisor connection or NULL in case of error
+ *
+ * URIs are documented at http://libvirt.org/uri.html
  */
 virConnectPtr
 virConnectOpenReadOnly(const char *name)

Attachment: smime.p7s
Description: S/MIME Cryptographic Signature


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]