From 96c795328d1d008ae3c6bc42e325efc04844ecac Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Mon, 17 Mar 2008 16:43:54 +0000 Subject: [PATCH] fixed DefinedDomains function comments c.f. 437216 * libvirt.c: fixed DefinedDomains function comments c.f. 437216 * docs/libvirt-*.xml docs/*/libvirt-libvirt.html: regenerated Daniel --- ChangeLog | 5 +++++ docs/devhelp/libvirt-libvirt.html | 4 ++-- docs/html/libvirt-libvirt.html | 4 ++-- docs/libvirt-api.xml | 4 ++-- docs/libvirt-refs.xml | 4 ++++ src/libvirt.c | 5 +++-- 6 files changed, 18 insertions(+), 8 deletions(-) diff --git a/ChangeLog b/ChangeLog index 10ccfe304e..c62eb278a0 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Mon Mar 17 17:40:12 CET 2008 Daniel Veillard + + * libvirt.c: fixed DefinedDomains function comments c.f. 437216 + * docs/libvirt-*.xml docs/*/libvirt-libvirt.html: regenerated + Mon Mar 17 11:10:22 EDT 2008 Daniel P. Berrange * src/storage_driver.c: Don't crash if backend is missing the diff --git a/docs/devhelp/libvirt-libvirt.html b/docs/devhelp/libvirt-libvirt.html index dbb2140633..ed6f39cce5 100644 --- a/docs/devhelp/libvirt-libvirt.html +++ b/docs/devhelp/libvirt-libvirt.html @@ -600,7 +600,7 @@ The content of this structure is not made public by the API.
conn:pointer to the hypervisor connection
hvVer:return value for the version of the running hypervisor (OUT)
Returns:-1 in case of error, 0 otherwise. if the version can't be extracted by lack of capacities returns 0 and @hvVer is 0, otherwise @hvVer value is major * 1,000,000 + minor * 1,000 + release

virConnectListDefinedDomains ()

int	virConnectListDefinedDomains	(virConnectPtr conn, 
					 char ** const names, 
					 int maxnames)

-

list the defined domains, stores the pointers to the names in @names

+

list the defined but inactive domains, stores the pointers to the names in @names

conn:pointer to the hypervisor connection
names:pointer to an array to store the names
maxnames:size of the array
Returns:the number of names provided in the array or -1 in case of error

virConnectListDefinedNetworks ()

int	virConnectListDefinedNetworks	(virConnectPtr conn, 
					 char ** const names, 
					 int maxnames)

@@ -624,7 +624,7 @@ The content of this structure is not made public by the API.
 
conn:pointer to hypervisor connection
names:array of char * to fill with pool names (allocated by caller)
maxnames:size of the names array
Returns:0 on success, -1 on error

virConnectNumOfDefinedDomains ()

int	virConnectNumOfDefinedDomains	(virConnectPtr conn)

-

Provides the number of inactive domains.

+

Provides the number of defined but inactive domains.

conn:pointer to the hypervisor connection
Returns:the number of domain found or -1 in case of error

virConnectNumOfDefinedNetworks ()

int	virConnectNumOfDefinedNetworks	(virConnectPtr conn)

diff --git a/docs/html/libvirt-libvirt.html b/docs/html/libvirt-libvirt.html
index 987bb57cfd..6cdbbbef2c 100644
--- a/docs/html/libvirt-libvirt.html
+++ b/docs/html/libvirt-libvirt.html
@@ -360,7 +360,7 @@ int	virConnectAuthCallbackPtr	(
conn:pointer to a hypervisor connection
Returns:the URI string which must be freed by the caller, or NULL if there was an error.

Function: virConnectGetVersion

int	virConnectGetVersion		(virConnectPtr conn, 
					 unsigned long * hvVer)

Get the version level of the Hypervisor running. This may work only with hypervisor call, i.e. with privileged access to the hypervisor, not with a Read-Only connection.

conn:pointer to the hypervisor connection
hvVer:return value for the version of the running hypervisor (OUT)
Returns:-1 in case of error, 0 otherwise. if the version can't be extracted by lack of capacities returns 0 and @hvVer is 0, otherwise @hvVer value is major * 1,000,000 + minor * 1,000 + release

Function: virConnectListDefinedDomains

int	virConnectListDefinedDomains	(virConnectPtr conn, 
					 char ** const names, 
					 int maxnames)

-

list the defined domains, stores the pointers to the names in @names

+

list the defined but inactive domains, stores the pointers to the names in @names

conn:pointer to the hypervisor connection
names:pointer to an array to store the names
maxnames:size of the array
Returns:the number of names provided in the array or -1 in case of error

Function: virConnectListDefinedNetworks

int	virConnectListDefinedNetworks	(virConnectPtr conn, 
					 char ** const names, 
					 int maxnames)

list the inactive networks, stores the pointers to the names in @names

conn:pointer to the hypervisor connection
names:pointer to an array to store the names
maxnames:size of the array
Returns:the number of names provided in the array or -1 in case of error

Function: virConnectListDefinedStoragePools

int	virConnectListDefinedStoragePools	(virConnectPtr conn, 
						 char ** const names, 
						 int maxnames)

@@ -372,7 +372,7 @@ int	virConnectAuthCallbackPtr	(
conn:pointer to the hypervisor connection
names:array to collect the list of names of active networks
maxnames:size of @names
Returns:the number of networks found or -1 in case of error
Function: virConnectListStoragePools
int	virConnectListStoragePools	(virConnectPtr conn, 
					 char ** const names, 
					 int maxnames)

 
Provides the list of names of active storage pools upto maxnames. If there are more than maxnames, the remaining names will be silently ignored.

 
conn:pointer to hypervisor connection
names:array of char * to fill with pool names (allocated by caller)
maxnames:size of the names array
Returns:0 on success, -1 on error
Function: virConnectNumOfDefinedDomains
int	virConnectNumOfDefinedDomains	(virConnectPtr conn)

-
Provides the number of inactive domains.

+

Provides the number of defined but inactive domains.

conn:pointer to the hypervisor connection
Returns:the number of domain found or -1 in case of error

Function: virConnectNumOfDefinedNetworks

int	virConnectNumOfDefinedNetworks	(virConnectPtr conn)

Provides the number of inactive networks.

conn:pointer to the hypervisor connection
Returns:the number of networks found or -1 in case of error

Function: virConnectNumOfDefinedStoragePools

int	virConnectNumOfDefinedStoragePools	(virConnectPtr conn)

diff --git a/docs/libvirt-api.xml b/docs/libvirt-api.xml
index c54dfa4b33..b23eeaee90 100644
--- a/docs/libvirt-api.xml
+++ b/docs/libvirt-api.xml
@@ -706,7 +706,7 @@
       
     
     
-      list the defined domains, stores the pointers to the names in @names
+      list the defined but inactive domains, stores the pointers to the names in @names
       
       
       
@@ -748,7 +748,7 @@
       
     
     
-      Provides the number of inactive domains.
+      Provides the number of defined but inactive domains.
       
       
     
diff --git a/docs/libvirt-refs.xml b/docs/libvirt-refs.xml
index 8b3d5c5a04..e9d189a40c 100644
--- a/docs/libvirt-refs.xml
+++ b/docs/libvirt-refs.xml
@@ -2177,6 +2177,8 @@
           
           
           
+          
+          
           
           
           
@@ -2516,6 +2518,7 @@
         
         
           
+          
           
           
           
@@ -3078,6 +3081,7 @@
           
         
         
+          
           
           
           
diff --git a/src/libvirt.c b/src/libvirt.c
index 5133762222..ecb5e26156 100644
--- a/src/libvirt.c
+++ b/src/libvirt.c
@@ -2642,7 +2642,7 @@ virDomainUndefine(virDomainPtr domain) {
  * virConnectNumOfDefinedDomains:
  * @conn: pointer to the hypervisor connection
  *
- * Provides the number of inactive domains.
+ * Provides the number of defined but inactive domains.
  *
  * Returns the number of domain found or -1 in case of error
  */
@@ -2669,7 +2669,8 @@ virConnectNumOfDefinedDomains(virConnectPtr conn)
  * @names: pointer to an array to store the names
  * @maxnames: size of the array
  *
- * list the defined domains, stores the pointers to the names in @names
+ * list the defined but inactive domains, stores the pointers to the names
+ * in @names
  *
  * Returns the number of names provided in the array or -1 in case of error
  */