diff --git a/ChangeLog b/ChangeLog index 8022e6a7009234bbd008c866306a7edf7219cbb9..5fadb1f0445ef09031900d89f402f3306b0a7a9c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Mon Mar 17 11:46:09 CET 2008 Daniel Veillard + + * src/libvirt.c docs/libvirt-*.xml docs/html/libvirt-libvirt.html: + fixed a few missing argument descriptions and regenerated. + Mon Mar 17 11:23:32 CET 2008 Daniel Veillard * NEWS virsh.1 docs//* include/libvirt/libvirt.h[.in] qemud/mdns.h diff --git a/docs/devhelp/libvirt-libvirt.html b/docs/devhelp/libvirt-libvirt.html index cf6314ad14ef30fac3faafc0c8efe7af75870130..dbb214063337788e9649e1069d79fdf6223bf63d 100644 --- a/docs/devhelp/libvirt-libvirt.html +++ b/docs/devhelp/libvirt-libvirt.html @@ -656,7 +656,7 @@ The content of this structure is not made public by the API.
name:URI of the hypervisor
auth:Authenticate callback parameters
flags:Open flags
Returns:a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html

virConnectOpenReadOnly ()

virConnectPtr	virConnectOpenReadOnly	(const char * name)

-

This function should be called first to get a restricted connection to the library functionalities. The set of APIs usable are then restricted on the available methods to control the domains.

+

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.

name:URI of the hypervisor
Returns:a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html

virDomainAttachDevice ()

int	virDomainAttachDevice		(virDomainPtr domain, 
					 const char * xml)

@@ -676,7 +676,7 @@ The content of this structure is not made public by the API.
 
domain:pointer to a defined domain
Returns:0 in case of success, -1 in case of error

virDomainCreateLinux ()

virDomainPtr	virDomainCreateLinux	(virConnectPtr conn, 
					 const char * xmlDesc, 
					 unsigned int flags)

-

Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires riviledged access to the hypervisor.

+

Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor.

conn:pointer to the hypervisor connection
xmlDesc:an XML description of the domain
flags:an optional set of virDomainFlags
Returns:a new domain object or NULL in case of failure

virDomainDefineXML ()

virDomainPtr	virDomainDefineXML	(virConnectPtr conn, 
					 const char * xml)

@@ -917,19 +917,19 @@ The content of this structure is not made public by the API.
         

         
virStoragePoolBuild ()
int	virStoragePoolBuild		(virStoragePoolPtr pool, 
					 unsigned int flags)

 
Build the underlying storage pool

-
pool:pointer to storage pool
flags:
Returns:0 on success, or -1 upon failure

+
pool:pointer to storage pool
flags:future flags, use 0 for now
Returns:0 on success, or -1 upon failure

virStoragePoolCreate ()

int	virStoragePoolCreate		(virStoragePoolPtr pool, 
					 unsigned int flags)

Starts an inactive storage pool

-
pool:pointer to storage pool
flags:
Returns:0 on success, or -1 if it could not be started
+
pool:pointer to storage pool
flags:future flags, use 0 for now
Returns:0 on success, or -1 if it could not be started

virStoragePoolCreateXML ()

virStoragePoolPtr	virStoragePoolCreateXML	(virConnectPtr conn, 
						 const char * xmlDesc, 
						 unsigned int flags)

-

Create a new storage based on its XML description. The pool is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted

-
conn:pointer to hypervisor connection
xmlDesc:XML description for new pool
flags:
Returns:a virStoragePoolPtr object, or NULL if creation failed
+

Create a new storage based on its XML description. The pool is not persitent, so its definition will disappear when it is destroyed, or if the host is restarted

+
conn:pointer to hypervisor connection
xmlDesc:XML description for new pool
flags:future flags, use 0 for now
Returns:a virStoragePoolPtr object, or NULL if creation failed

virStoragePoolDefineXML ()

virStoragePoolPtr	virStoragePoolDefineXML	(virConnectPtr conn, 
						 const char * xml, 
						 unsigned int flags)

Define a new inactive storage pool based on its XML description. The pool is persitent, until explicitly undefined.

-
conn:pointer to hypervisor connection
xml:XML description for new pool
flags:
Returns:a virStoragePoolPtr object, or NULL if creation failed
+
conn:pointer to hypervisor connection
xml:XML description for new pool
flags:future flags, use 0 for now
Returns:a virStoragePoolPtr object, or NULL if creation failed

virStoragePoolDelete ()

int	virStoragePoolDelete		(virStoragePoolPtr pool, 
					 unsigned int flags)

Delete the underlying pool resources. This is a non-recoverable operation. The virStoragePoolPtr object itself is not free'd.

@@ -969,7 +969,7 @@ The content of this structure is not made public by the API.

virStoragePoolGetXMLDesc ()

char *	virStoragePoolGetXMLDesc	(virStoragePoolPtr pool, 
					 unsigned int flags)

Fetch an XML document describing all aspects of the storage pool. This is suitable for later feeding back into the virStoragePoolCreateXML method.

-
pool:pointer to storage pool
flags:flags for XML format options (unused, pass 0)
Returns:a XML document, or NULL on error
+
pool:pointer to storage pool
flags:flags for XML format options (set of virDomainXMLFlags)
Returns:a XML document, or NULL on error

virStoragePoolListVolumes ()

int	virStoragePoolListVolumes	(virStoragePoolPtr pool, 
					 char ** const names, 
					 int maxnames)

Fetch list of storage volume names, limiting to at most maxnames.

@@ -1013,7 +1013,7 @@ The content of this structure is not made public by the API.

virStorageVolDelete ()

int	virStorageVolDelete		(virStorageVolPtr vol, 
					 unsigned int flags)

Delete the storage volume from the pool

-
vol:pointer to storage volume
flags:
Returns:0 on success, or -1 on error
+
vol:pointer to storage volume
flags:future flags, use 0 for now
Returns:0 on success, or -1 on error

virStorageVolFree ()

int	virStorageVolFree		(virStorageVolPtr vol)

Release the storage volume handle. The underlying storage volume contains to exist

diff --git a/docs/html/libvirt-libvirt.html b/docs/html/libvirt-libvirt.html index a77f843ed0b90bdc2c59ab8a50bfeae89ef5e4db..987bb57cfd1f6ecc31fe116a5b8e6ac6fe28ebbb 100644 --- a/docs/html/libvirt-libvirt.html +++ b/docs/html/libvirt-libvirt.html @@ -519,13 +519,13 @@ int virConnectAuthCallbackPtr (
conn:pointer to the hypervisor connection
info:pointer to a virNodeInfo structure allocated by the user
Returns:0 in case of success and -1 in case of failure.

Function: virStoragePoolBuild

int	virStoragePoolBuild		(virStoragePoolPtr pool, 
					 unsigned int flags)

Build the underlying storage pool

-
pool:pointer to storage pool
flags:
Returns:0 on success, or -1 upon failure

Function: virStoragePoolCreate

int	virStoragePoolCreate		(virStoragePoolPtr pool, 
					 unsigned int flags)

+
pool:pointer to storage pool
flags:future flags, use 0 for now
Returns:0 on success, or -1 upon failure
Function: virStoragePoolCreate
int	virStoragePoolCreate		(virStoragePoolPtr pool, 
					 unsigned int flags)

 
Starts an inactive storage pool

-
pool:pointer to storage pool
flags:
Returns:0 on success, or -1 if it could not be started
Function: virStoragePoolCreateXML
virStoragePoolPtr	virStoragePoolCreateXML	(virConnectPtr conn, 
						 const char * xmlDesc, 
						 unsigned int flags)

+
pool:pointer to storage pool
flags:future flags, use 0 for now
Returns:0 on success, or -1 if it could not be started
Function: virStoragePoolCreateXML
virStoragePoolPtr	virStoragePoolCreateXML	(virConnectPtr conn, 
						 const char * xmlDesc, 
						 unsigned int flags)

 
Create a new storage based on its XML description. The pool is not persitent, so its definition will disappear when it is destroyed, or if the host is restarted

-
conn:pointer to hypervisor connection
xmlDesc:XML description for new pool
flags:
Returns:a virStoragePoolPtr object, or NULL if creation failed
Function: virStoragePoolDefineXML
virStoragePoolPtr	virStoragePoolDefineXML	(virConnectPtr conn, 
						 const char * xml, 
						 unsigned int flags)

+
conn:pointer to hypervisor connection
xmlDesc:XML description for new pool
flags:future flags, use 0 for now
Returns:a virStoragePoolPtr object, or NULL if creation failed
Function: virStoragePoolDefineXML
virStoragePoolPtr	virStoragePoolDefineXML	(virConnectPtr conn, 
						 const char * xml, 
						 unsigned int flags)

 
Define a new inactive storage pool based on its XML description. The pool is persitent, until explicitly undefined.

-
conn:pointer to hypervisor connection
xml:XML description for new pool
flags:
Returns:a virStoragePoolPtr object, or NULL if creation failed
Function: virStoragePoolDelete
int	virStoragePoolDelete		(virStoragePoolPtr pool, 
					 unsigned int flags)

+
conn:pointer to hypervisor connection
xml:XML description for new pool
flags:future flags, use 0 for now
Returns:a virStoragePoolPtr object, or NULL if creation failed
Function: virStoragePoolDelete
int	virStoragePoolDelete		(virStoragePoolPtr pool, 
					 unsigned int flags)

 
Delete the underlying pool resources. This is a non-recoverable operation. The virStoragePoolPtr object itself is not free'd.

 
pool:pointer to storage pool
flags:flags for obliteration process
Returns:0 on success, or -1 if it could not be obliterate
Function: virStoragePoolDestroy
int	virStoragePoolDestroy		(virStoragePoolPtr pool)

 
Destroy an active storage pool. This will deactivate the pool on the host, but keep any persistent config associated with it. If it has a persistent config it can later be restarted with virStoragePoolCreate(). This does not free the associated virStoragePoolPtr object.

@@ -545,7 +545,7 @@ int	virConnectAuthCallbackPtr	(
pool:pointer to storage pool
buf:buffer of VIR_UUID_STRING_BUFLEN bytes in size
Returns:0 on success, or -1 on error;
Function: virStoragePoolGetXMLDesc
char *	virStoragePoolGetXMLDesc	(virStoragePoolPtr pool, 
					 unsigned int flags)

 
Fetch an XML document describing all aspects of the storage pool. This is suitable for later feeding back into the virStoragePoolCreateXML method.

-
pool:pointer to storage pool
flags:flags for XML format options (unused, pass 0)
Returns:a XML document, or NULL on error
Function: virStoragePoolListVolumes
int	virStoragePoolListVolumes	(virStoragePoolPtr pool, 
					 char ** const names, 
					 int maxnames)

+
pool:pointer to storage pool
flags:flags for XML format options (set of virDomainXMLFlags)
Returns:a XML document, or NULL on error
Function: virStoragePoolListVolumes
int	virStoragePoolListVolumes	(virStoragePoolPtr pool, 
					 char ** const names, 
					 int maxnames)

 
Fetch list of storage volume names, limiting to at most maxnames.

 
pool:pointer to storage pool
names:array in which to storage volume names
maxnames:size of names array
Returns:the number of names fetched, or -1 on error
Function: virStoragePoolLookupByName
virStoragePoolPtr	virStoragePoolLookupByName	(virConnectPtr conn, 
							 const char * name)

 
Fetch a storage pool based on its unique name

@@ -567,7 +567,7 @@ int	virConnectAuthCallbackPtr	(
pool:pointer to storage pool
xmldesc:description of volume to create
flags:flags for creation (unused, pass 0)
Returns:the storage volume, or NULL on error
Function: virStorageVolDelete
int	virStorageVolDelete		(virStorageVolPtr vol, 
					 unsigned int flags)

 
Delete the storage volume from the pool

-
vol:pointer to storage volume
flags:
Returns:0 on success, or -1 on error
Function: virStorageVolFree
int	virStorageVolFree		(virStorageVolPtr vol)

+
vol:pointer to storage volume
flags:future flags, use 0 for now
Returns:0 on success, or -1 on error
Function: virStorageVolFree
int	virStorageVolFree		(virStorageVolPtr vol)

 
Release the storage volume handle. The underlying storage volume contains to exist

 
vol:pointer to storage volume
Returns:0 on success, or -1 on error
Function: virStorageVolGetConnect
virConnectPtr	virStorageVolGetConnect	(virStorageVolPtr vol)

 
Provides the connection pointer associated with a storage volume. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the volume object together.

diff --git a/docs/libvirt-api.xml b/docs/libvirt-api.xml
index d19025e55a7c9ca239795bccb783168946e7aef1..c54dfa4b33d60cb386c243a3d13512243520bc68 100644
--- a/docs/libvirt-api.xml
+++ b/docs/libvirt-api.xml
@@ -790,7 +790,7 @@
       
     
     
-      This function should be called first to get a restricted connection to the library functionalities. The set of APIs usable are then restricted on the available methods to control the domains.
+      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.
       
       
     
@@ -831,7 +831,7 @@
       
     
     
-      Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires riviledged access to the hypervisor.
+      Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor.
       
       
       
@@ -1214,27 +1214,27 @@
       Build the underlying storage pool
       
       
-      
+      
     
     
       Starts an inactive storage pool
       
       
-      
+      
     
     
-      Create a new storage based on its XML description. The pool is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted
+      Create a new storage based on its XML description. The pool is not persitent, so its definition will disappear when it is destroyed, or if the host is restarted
       
       
       
-      
+      
     
     
       Define a new inactive storage pool based on its XML description. The pool is persitent, until explicitly undefined.
       
       
       
-      
+      
     
     
       Delete the underlying pool resources. This is a non-recoverable operation. The virStoragePoolPtr object itself is not free'd.
@@ -1290,7 +1290,7 @@
       Fetch an XML document describing all aspects of the storage pool. This is suitable for later feeding back into the virStoragePoolCreateXML method.
       
       
-      
+      
     
     
       Fetch list of storage volume names, limiting to at most maxnames.
@@ -1355,7 +1355,7 @@
       Delete the storage volume from the pool
       
       
-      
+      
     
     
       Release the storage volume handle. The underlying storage volume contains to exist
diff --git a/docs/libvirt-refs.xml b/docs/libvirt-refs.xml
index b0e9fc4169ca3357c8f2900239a5284c47ab1629..8b3d5c5a04017ee3d1fa86fe5a7c793c98927f7f 100644
--- a/docs/libvirt-refs.xml
+++ b/docs/libvirt-refs.xml
@@ -2790,10 +2790,15 @@
           
           
           
+          
+          
+          
+          
           
           
           
           
+          
           
         
         
@@ -2912,6 +2917,13 @@
           
           
         
+        
+          
+          
+          
+          
+          
+        
       
     
     
@@ -3001,6 +3013,7 @@
           
           
           
+          
         
         
           
@@ -3044,9 +3057,6 @@
         
           
         
-        
-          
-        
         
           
         
@@ -3592,11 +3602,9 @@
           
           
         
-        
-          
-        
         
           
+          
         
         
           
@@ -3652,13 +3660,17 @@
           
           
         
+        
+          
+          
+          
+          
+          
+        
         
           
           
         
-        
-          
-        
       
       
         
@@ -3779,7 +3791,6 @@
         
         
           
-          
           
           
         
@@ -3837,10 +3848,6 @@
           
           
         
-        
-          
-          
-        
         
           
         
@@ -4187,6 +4194,7 @@
           
           
           
+          
         
         
           
@@ -4611,7 +4619,6 @@
         
         
           
-          
           
           
           
@@ -4648,8 +4655,13 @@
           
           
           
+          
+          
+          
+          
           
           
+          
           
         
         
@@ -4802,6 +4814,7 @@
         
         
           
+          
         
         
           
diff --git a/src/libvirt.c b/src/libvirt.c
index d10a39f6226bd2c530771512de570d6e47c0a1d8..51337622225ca8d0e96c5e8ecf8940f885f11a87 100644
--- a/src/libvirt.c
+++ b/src/libvirt.c
@@ -4032,6 +4032,7 @@ virStoragePoolLookupByVolume(virStorageVolPtr vol)
  * virStoragePoolCreateXML:
  * @conn: pointer to hypervisor connection
  * @xmlDesc: XML description for new pool
+ * @flags: future flags, use 0 for now
  *
  * Create a new storage based on its XML description. The
  * pool is not persitent, so its definition will disappear
@@ -4070,6 +4071,7 @@ virStoragePoolCreateXML(virConnectPtr conn,
  * virStoragePoolDefineXML:
  * @conn: pointer to hypervisor connection
  * @xml: XML description for new pool
+ * @flags: future flags, use 0 for now
  *
  * Define a new inactive storage pool based on its XML description. The
  * pool is persitent, until explicitly undefined.
@@ -4107,6 +4109,7 @@ virStoragePoolDefineXML(virConnectPtr conn,
 /**
  * virStoragePoolBuild:
  * @pool: pointer to storage pool
+ * @flags: future flags, use 0 for now
  *
  * Build the underlying storage pool
  *
@@ -4174,6 +4177,7 @@ virStoragePoolUndefine(virStoragePoolPtr pool)
 /**
  * virStoragePoolCreate:
  * @pool: pointer to storage pool
+ * @flags: future flags, use 0 for now
  *
  * Starts an inactive storage pool
  *
@@ -4472,7 +4476,7 @@ virStoragePoolGetInfo(virStoragePoolPtr pool,
 /**
  * virStoragePoolGetXMLDesc:
  * @pool: pointer to storage pool
- * @flags: flags for XML format options (unused, pass 0)
+ * @flags: flags for XML format options (set of virDomainXMLFlags)
  *
  * Fetch an XML document describing all aspects of the
  * storage pool. This is suitable for later feeding back
@@ -4847,6 +4851,7 @@ virStorageVolCreateXML(virStoragePoolPtr pool,
 /**
  * virStorageVolDelete:
  * @vol: pointer to storage volume
+ * @flags: future flags, use 0 for now
  *
  * Delete the storage volume from the pool
  *