diff --git a/ChangeLog b/ChangeLog
index bc0ed8e5d3..b2236a7c4f 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 be5eb4441d..6cfe02829f 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 002e0d21a2..6e9c3a2e59 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 f2c9a5d536..193f0e8df0 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.
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: | |
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. |
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 |
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 |
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. |
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). |
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 |
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 c29fba80ab..3003444bf5 100644
--- a/docs/html/libvirt-virterror.html
+++ b/docs/html/libvirt-virterror.html
@@ -27,7 +27,7 @@ void virSetErrorFunc (void * userData,
int | code | : The error code, a virErrorNumber |
int | domain | : What part of the library raised this error |
char * | message | : human-readable informative error message |
virErrorLevel | level | : how consequent is the error |
virConnectPtr | conn | : connection if available, deprecated see note above |
virDomainPtr | dom | : domain if available, deprecated see note above |
char * | str1 | : extra string information |
char * | str2 | : extra string information |
char * | str3 | : extra string information |
int | int1 | : extra number information |
int | int2 | : extra number information |
virNetworkPtr | net | : network if available, deprecated see note above |
}
enum virErrorDomain {
-
}
+
}
enum virErrorNumber {
diff --git a/docs/libvirt-api.xml b/docs/libvirt-api.xml
index 81bfbda43c..73160b1016 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 86ffb4676e..f486cc86d5 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 @@
-
-
+
+
-
-
-
-
+
+
+
+
+