diff --git a/ChangeLog b/ChangeLog index bc0ed8e5d39db9effaa20b05742aa97807ca6b15..b2236a7c4fd34639929d254c556efd748126b762 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +Sun Apr 19 16:14:22 BST 2009 Daniel P. Berrange + + * docs/libvirt-api.xml, docs/libvirt-refs.xml, + docs/devhelp/libvirt-libvirt.html, docs/devhelp/libvirt-virterror.html, + docs/html/libvirt-libvirt.html, docs/html/libvirt-virterror.html: + Regenerate API docs to pull in latest VBox error code definitions + Sun Apr 19 16:12:22 BST 2009 Daniel P. Berrange * src/Makefile.am: Add 2 missing vbox files to EXTRA_DIST diff --git a/docs/devhelp/libvirt-libvirt.html b/docs/devhelp/libvirt-libvirt.html index be5eb4441d988feb2cf40952081a67ca901663de..6cfe02829fbebb946870105eb89b7d452c1ebfa4 100644 --- a/docs/devhelp/libvirt-libvirt.html +++ b/docs/devhelp/libvirt-libvirt.html @@ -1205,8 +1205,8 @@ The content of this structure is not made public by the API.
conn:pointer to the hypervisor connection
freeMems:pointer to the array of unsigned long long
startCell:index of first cell to return freeMems info on.
maxCells:Maximum number of cells for which freeMems information can be returned.
Returns:the number of entries filled in freeMems, or -1 in case of error.

virNodeGetFreeMemory ()

unsigned long long	virNodeGetFreeMemory	(virConnectPtr conn)

-

provides the free memory available on the Node

-
conn:pointer to the hypervisor connection
Returns:the available free memory in kilobytes or 0 in case of error
+

provides the free memory available on the Node Note: most libvirt APIs provide memory sizes in kilobytes, but in this function the returned value is in bytes. Divide by 1024 as necessary.

+
conn:pointer to the hypervisor connection
Returns:the available free memory in bytes or 0 in case of error

virNodeGetInfo ()

int	virNodeGetInfo			(virConnectPtr conn, 
					 virNodeInfoPtr info)

Extract hardware information about the node.

diff --git a/docs/devhelp/libvirt-virterror.html b/docs/devhelp/libvirt-virterror.html index 002e0d21a2f6b8d8c0329f9705dd0fdd5882860c..6e9c3a2e596c0b6aea495c7d4ef024aa617102c6 100644 --- a/docs/devhelp/libvirt-virterror.html +++ b/docs/devhelp/libvirt-virterror.html @@ -106,7 +106,8 @@ void virConnResetLastError (VIR_FROM_UML = 21 /* Error at the UML driver */ VIR_FROM_NODEDEV = 22 /* Error from node device monitor */ VIR_FROM_XEN_INOTIFY = 23 /* Error from xen inotify layer */ - VIR_FROM_SECURITY = 24 /* Error from security framework */ + VIR_FROM_SECURITY = 24 /* Error from security framework */ + VIR_FROM_VBOX = 25 /* Error from VirtualBox driver */ };

diff --git a/docs/html/libvirt-libvirt.html b/docs/html/libvirt-libvirt.html index f2c9a5d536e8962a2aca2d923cc63175c5c1f17a..193f0e8df07a4515e8c138d37670f02049d2e022 100644 --- a/docs/html/libvirt-libvirt.html +++ b/docs/html/libvirt-libvirt.html @@ -472,7 +472,7 @@ int virStorageVolRef (virNodeDeviceFree to release the reference count, once the caller no longer needs the reference to this object. This method is typically useful for applications where multiple threads are using a connection, and it is required that the connection remain open until all threads have finished using it. ie, each new thread using a dev would increment the reference count.

dev:
Returns:

virNodeDeviceReset

int	virNodeDeviceReset		(virNodeDevicePtr dev)

Reset a previously dettached node device to the node before or after assigning it to a guest. The exact reset semantics depends on the hypervisor and device type but, for example, KVM will attempt to reset PCI devices with a Function Level Reset, Secondary Bus Reset or a Power Management D-State reset. If the reset will affect other devices which are currently in use, this function may fail.

dev:pointer to the node device
Returns:

virNodeGetCellsFreeMemory

int	virNodeGetCellsFreeMemory	(virConnectPtr conn, 
					 unsigned long long * freeMems, 
					 int startCell, 
					 int maxCells)

This call returns the amount of free memory in one or more NUMA cells. The @freeMems array must be allocated by the caller and will be filled with the amount of free memory in kilobytes for each cell requested, starting with startCell (in freeMems[0]), up to either (startCell + maxCells), or the number of additional cells in the node, whichever is smaller.

conn:pointer to the hypervisor connection
freeMems:pointer to the array of unsigned long long
startCell:index of first cell to return freeMems info on.
maxCells:Maximum number of cells for which freeMems information can be returned.
Returns:the number of entries filled in freeMems, or -1 in case of error.

virNodeGetFreeMemory

unsigned long long	virNodeGetFreeMemory	(virConnectPtr conn)

-

provides the free memory available on the Node

conn:pointer to the hypervisor connection
Returns:the available free memory in kilobytes or 0 in case of error

virNodeGetInfo

int	virNodeGetInfo			(virConnectPtr conn, 
					 virNodeInfoPtr info)

+

provides the free memory available on the Node Note: most libvirt APIs provide memory sizes in kilobytes, but in this function the returned value is in bytes. Divide by 1024 as necessary.

conn:pointer to the hypervisor connection
Returns:the available free memory in bytes or 0 in case of error

virNodeGetInfo

int	virNodeGetInfo			(virConnectPtr conn, 
					 virNodeInfoPtr info)

Extract hardware information about the node.

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.

virNodeGetSecurityModel

int	virNodeGetSecurityModel		(virConnectPtr conn, 
					 virSecurityModelPtr secmodel)

Extract the security model of a hypervisor.

conn:a connection object
secmodel:pointer to a virSecurityModel structure
Returns:0 in case of success, -1 in case of failure, and -2 if the operation is not supported (caller decides if that's an error).

virNodeListDevices

int	virNodeListDevices		(virConnectPtr conn, 
					 const char * cap, 
					 char ** const names, 
					 int maxnames, 
					 unsigned int flags)

Collect the list of node devices, and store their names in @names If the optional 'cap' argument is non-NULL, then the count will be restricted to devices with the specified capability

conn:pointer to the hypervisor connection
cap:capability name
names:array to collect the list of node device names
maxnames:size of @names
flags:flags (unused, pass 0)
Returns:the number of node devices found or -1 in case of error

virNodeNumOfDevices

int	virNodeNumOfDevices		(virConnectPtr conn, 
					 const char * cap, 
					 unsigned int flags)

diff --git a/docs/html/libvirt-virterror.html b/docs/html/libvirt-virterror.html
index c29fba80ab3e13fdfdcb39fa39033bd326dd4ecc..3003444bf57e9f7b7252fc38c669f9baa5c33ccb 100644
--- a/docs/html/libvirt-virterror.html
+++ b/docs/html/libvirt-virterror.html
@@ -27,7 +27,7 @@ void	virSetErrorFunc			(void * userData,
intcode : The error code, a virErrorNumber
intdomain : What part of the library raised this error
char *message : human-readable informative error message
virErrorLevellevel : how consequent is the error
virConnectPtrconn : connection if available, deprecated see note above
virDomainPtrdom : domain if available, deprecated see note above
char *str1 : extra string information
char *str2 : extra string information
char *str3 : extra string information
intint1 : extra number information
intint2 : extra number information
virNetworkPtrnet : network if available, deprecated see note above
 }

virErrorDomain

enum virErrorDomain {
-
VIR_FROM_NONE = 0
VIR_FROM_XEN = 1 : Error at Xen hypervisor layer
VIR_FROM_XEND = 2 : Error at connection with xend daemon
VIR_FROM_XENSTORE = 3 : Error at connection with xen store
VIR_FROM_SEXPR = 4 : Error in the S-Expression code
VIR_FROM_XML = 5 : Error in the XML code
VIR_FROM_DOM = 6 : Error when operating on a domain
VIR_FROM_RPC = 7 : Error in the XML-RPC code
VIR_FROM_PROXY = 8 : Error in the proxy code
VIR_FROM_CONF = 9 : Error in the configuration file handling
VIR_FROM_QEMU = 10 : Error at the QEMU daemon
VIR_FROM_NET = 11 : Error when operating on a network
VIR_FROM_TEST = 12 : Error from test driver
VIR_FROM_REMOTE = 13 : Error from remote driver
VIR_FROM_OPENVZ = 14 : Error from OpenVZ driver
VIR_FROM_XENXM = 15 : Error at Xen XM layer
VIR_FROM_STATS_LINUX = 16 : Error in the Linux Stats code
VIR_FROM_LXC = 17 : Error from Linux Container driver
VIR_FROM_STORAGE = 18 : Error from storage driver
VIR_FROM_NETWORK = 19 : Error from network config
VIR_FROM_DOMAIN = 20 : Error from domain config
VIR_FROM_UML = 21 : Error at the UML driver
VIR_FROM_NODEDEV = 22 : Error from node device monitor
VIR_FROM_XEN_INOTIFY = 23 : Error from xen inotify layer
VIR_FROM_SECURITY = 24 : Error from security framework
}
+
VIR_FROM_NONE = 0
VIR_FROM_XEN = 1 : Error at Xen hypervisor layer
VIR_FROM_XEND = 2 : Error at connection with xend daemon
VIR_FROM_XENSTORE = 3 : Error at connection with xen store
VIR_FROM_SEXPR = 4 : Error in the S-Expression code
VIR_FROM_XML = 5 : Error in the XML code
VIR_FROM_DOM = 6 : Error when operating on a domain
VIR_FROM_RPC = 7 : Error in the XML-RPC code
VIR_FROM_PROXY = 8 : Error in the proxy code
VIR_FROM_CONF = 9 : Error in the configuration file handling
VIR_FROM_QEMU = 10 : Error at the QEMU daemon
VIR_FROM_NET = 11 : Error when operating on a network
VIR_FROM_TEST = 12 : Error from test driver
VIR_FROM_REMOTE = 13 : Error from remote driver
VIR_FROM_OPENVZ = 14 : Error from OpenVZ driver
VIR_FROM_XENXM = 15 : Error at Xen XM layer
VIR_FROM_STATS_LINUX = 16 : Error in the Linux Stats code
VIR_FROM_LXC = 17 : Error from Linux Container driver
VIR_FROM_STORAGE = 18 : Error from storage driver
VIR_FROM_NETWORK = 19 : Error from network config
VIR_FROM_DOMAIN = 20 : Error from domain config
VIR_FROM_UML = 21 : Error at the UML driver
VIR_FROM_NODEDEV = 22 : Error from node device monitor
VIR_FROM_XEN_INOTIFY = 23 : Error from xen inotify layer
VIR_FROM_SECURITY = 24 : Error from security framework
VIR_FROM_VBOX = 25 : Error from VirtualBox driver
}

virErrorLevel

enum virErrorLevel {
VIR_ERR_NONE = 0
VIR_ERR_WARNING = 1 : A simple warning
VIR_ERR_ERROR = 2 : An error
}

virErrorNumber

enum virErrorNumber {
diff --git a/docs/libvirt-api.xml b/docs/libvirt-api.xml
index 81bfbda43cf4dc63981870098c4d1e0fba662eac..73160b10160148208ddf1ffba4042e8c87c9c745 100644
--- a/docs/libvirt-api.xml
+++ b/docs/libvirt-api.xml
@@ -356,6 +356,7 @@
      
      
      
+     
      
      
      
@@ -608,12 +609,13 @@
     
     
     
-    
+    
     
     
     
     
     
+    
     
     
     
@@ -1563,8 +1565,8 @@ see note above'/>
       
     
     
-      provides the free memory available on the Node
-      
+      provides the free memory available on the Node Note: most libvirt APIs provide memory sizes in kilobytes, but in this function the returned value is in bytes. Divide by 1024 as necessary.
+      
       
     
     
diff --git a/docs/libvirt-refs.xml b/docs/libvirt-refs.xml
index 86ffb4676e4f0260fe64cf1ab4763795b6a6599c..f486cc86d55b781fd7285ca860e4287a7922e857 100644
--- a/docs/libvirt-refs.xml
+++ b/docs/libvirt-refs.xml
@@ -132,6 +132,7 @@
     
     
     
+    
     
     
     
@@ -553,6 +554,7 @@
       
       
       
+      
       
       
       
@@ -1631,6 +1633,7 @@
       
       
       
+      
       
       
       
@@ -1679,6 +1682,7 @@
           
           
           
+          
         
         
           
@@ -1822,6 +1826,9 @@
           
           
         
+        
+          
+        
         
           
         
@@ -2025,6 +2032,8 @@
           
         
       
+    
+    
       
         
           
@@ -2049,8 +2058,6 @@
           
         
       
-    
-    
       
         
           
@@ -2083,6 +2090,9 @@
           
           
         
+        
+          
+        
       
       
         
@@ -2878,6 +2888,7 @@
           
           
           
+          
           
         
         
@@ -4355,6 +4366,7 @@
           
           
           
+          
           
           
         
@@ -4631,6 +4643,7 @@
           
         
         
+          
           
         
         
@@ -4703,6 +4716,7 @@
         
           
           
+          
         
         
           
@@ -5113,6 +5127,9 @@
           
           
         
+        
+          
+        
         
           
           
@@ -5420,6 +5437,7 @@
           
           
           
+          
         
         
           
@@ -5464,6 +5482,8 @@
           
         
       
+    
+    
       
         
           
@@ -5598,6 +5618,9 @@
         
           
         
+        
+          
+        
         
           
         
@@ -5844,7 +5867,7 @@
         
       
     
-    
+    
       
         
           
@@ -6228,7 +6251,7 @@
         
       
     
-    
+    
       
         
           
@@ -6250,6 +6273,7 @@
           
           
           
+          
           
         
         
@@ -6633,7 +6657,7 @@
         
       
     
-    
+    
       
         
           
@@ -6671,18 +6695,19 @@
       
     
     
-      
-      
+      
+      
       
       
       
       
       
       
-      
-      
-      
-      
+      
+      
+      
+      
+