diff --git a/ChangeLog b/ChangeLog index f20bd4fd03..049f515d5b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +Mon Mar 3 07:16:35 CET 2008 Daniel Veillard + + * include/libvirt/libvirt.h include/libvirt/libvirt.h.in: + missing comments for _virDomainBlockStats fields + * docs/*: rebuilt docs + Fri Feb 29 18:01:14 CET 2008 Daniel Veillard * qemud/Makefile.am: fix a broken line split diff --git a/NEWS b/NEWS index 581acb6aeb..30cdfa1fdb 100644 --- a/NEWS +++ b/NEWS @@ -10,7 +10,7 @@ Releases Ruby bindings (David Lutterkort), SASL based authentication for libvirt remote support (Daniel Berrange), PolicyKit authentication (Daniel Berrange) - - Documentation: example files for QEMU and libvirtd configuations + - Documentation: example files for QEMU and libvirtd configurations (Daniel Berrange), english cleanups (Jim Paris), CIM and OpenVZ references, document , daemon startup when using QEMU/KVM, document HV support for new NUMA calls (Richard Jones), diff --git a/docs/devhelp/libvirt-libvirt.html b/docs/devhelp/libvirt-libvirt.html index 27f790f033..c713056da1 100644 --- a/docs/devhelp/libvirt-libvirt.html +++ b/docs/devhelp/libvirt-libvirt.html @@ -227,15 +227,15 @@ int virConnectListNetworks (

Macro VIR_COPY_CPUMAP

#define VIR_COPY_CPUMAP(cpumaps, maplen, vcpu, cpumap);
-

This macro is to be used in conjonction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_COPY_CPUMAP macro extract the cpumap of the specified vcpu from cpumaps array and copy it into cpumap to be used later by virDomainPinVcpu() API.

cpumaps:pointer to an array of cpumap (in 8-bit bytes) (IN)
maplen:the length (in bytes) of one cpumap
vcpu:the virtual CPU number
cpumap:pointer to a cpumap (in 8-bit bytes) (OUT) This cpumap must be previously allocated by the caller (ie: malloc(maplen))
+

This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_COPY_CPUMAP macro extract the cpumap of the specified vcpu from cpumaps array and copy it into cpumap to be used later by virDomainPinVcpu() API.

cpumaps:pointer to an array of cpumap (in 8-bit bytes) (IN)
maplen:the length (in bytes) of one cpumap
vcpu:the virtual CPU number
cpumap:pointer to a cpumap (in 8-bit bytes) (OUT) This cpumap must be previously allocated by the caller (ie: malloc(maplen))

Macro VIR_CPU_MAPLEN

#define VIR_CPU_MAPLEN(cpu);
-

This macro is to be used in conjonction with virDomainPinVcpu() API. It returns the length (in bytes) required to store the complete CPU map between a single virtual & all physical CPUs of a domain.

cpu:number of physical CPUs
+

This macro is to be used in conjunction with virDomainPinVcpu() API. It returns the length (in bytes) required to store the complete CPU map between a single virtual & all physical CPUs of a domain.

cpu:number of physical CPUs

Macro VIR_CPU_USABLE

#define VIR_CPU_USABLE(cpumaps, maplen, vcpu, cpu);
-

This macro is to be used in conjonction with virDomainGetVcpus() API. VIR_CPU_USABLE macro returns a non zero value (true) if the cpu is usable by the vcpu, and 0 otherwise.

cpumaps:pointer to an array of cpumap (in 8-bit bytes) (IN)
maplen:the length (in bytes) of one cpumap
vcpu:the virtual CPU number
cpu:the physical CPU number
+

This macro is to be used in conjunction with virDomainGetVcpus() API. VIR_CPU_USABLE macro returns a non zero value (true) if the cpu is usable by the vcpu, and 0 otherwise.

cpumaps:pointer to an array of cpumap (in 8-bit bytes) (IN)
maplen:the length (in bytes) of one cpumap
vcpu:the virtual CPU number
cpu:the physical CPU number

Macro VIR_DOMAIN_SCHED_FIELD_LENGTH

#define VIR_DOMAIN_SCHED_FIELD_LENGTH;
@@ -243,19 +243,19 @@ int	virConnectListNetworks		(
Macro VIR_GET_CPUMAP
#define VIR_GET_CPUMAP(cpumaps, maplen, vcpu);
-
This macro is to be used in conjonction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_GET_CPUMAP macro returns a pointer to the cpumap of the specified vcpu from cpumaps array.
cpumaps:pointer to an array of cpumap (in 8-bit bytes) (IN)
maplen:the length (in bytes) of one cpumap
vcpu:the virtual CPU number

+

This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_GET_CPUMAP macro returns a pointer to the cpumap of the specified vcpu from cpumaps array.

cpumaps:pointer to an array of cpumap (in 8-bit bytes) (IN)
maplen:the length (in bytes) of one cpumap
vcpu:the virtual CPU number

Macro VIR_NODEINFO_MAXCPUS

#define VIR_NODEINFO_MAXCPUS(nodeinfo);
-

This macro is to calculate the total number of CPUs supported but not neccessarily active in the host.

nodeinfo:virNodeInfo instance
+

This macro is to calculate the total number of CPUs supported but not necessary active in the host.

nodeinfo:virNodeInfo instance

Macro VIR_UNUSE_CPU

#define VIR_UNUSE_CPU(cpumap, cpu);
-

This macro is to be used in conjonction with virDomainPinVcpu() API. USE_CPU macro reset the bit (CPU not usable) of the related cpu in cpumap.

cpumap:pointer to a bit map of real CPUs (in 8-bit bytes) (IN/OUT)
cpu:the physical CPU number
+

This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro reset the bit (CPU not usable) of the related cpu in cpumap.

cpumap:pointer to a bit map of real CPUs (in 8-bit bytes) (IN/OUT)
cpu:the physical CPU number

Macro VIR_USE_CPU

#define VIR_USE_CPU(cpumap, cpu);
-

This macro is to be used in conjonction with virDomainPinVcpu() API. USE_CPU macro set the bit (CPU usable) of the related cpu in cpumap.

cpumap:pointer to a bit map of real CPUs (in 8-bit bytes) (IN/OUT)
cpu:the physical CPU number
+

This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro set the bit (CPU usable) of the related cpu in cpumap.

cpumap:pointer to a bit map of real CPUs (in 8-bit bytes) (IN/OUT)
cpu:the physical CPU number

Macro VIR_UUID_BUFLEN

#define VIR_UUID_BUFLEN;
@@ -335,10 +335,10 @@ The content of this structure is not made public by the API.

Structure virDomainBlockStatsStruct

struct _virDomainBlockStats {
-    long long	rd_req
-    long long	rd_bytes
-    long long	wr_req
-    long long	wr_bytes
+    long long	rd_req	: number of read requests
+    long long	rd_bytes	: number of read bytes
+    long long	wr_req	: number of write requests
+    long long	wr_bytes	: numbber of written bytes
     long long	errs	: In Xen this returns the mysterious 'oo_req'.
 } virDomainBlockStatsStruct;

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

Typedef virDomainInterfaceStatsPtr

virDomainInterfaceStatsStruct * virDomainInterfaceStatsPtr;
-

A pointe to a virDomainInterfaceStats structure

+

A pointer to a virDomainInterfaceStats structure

Structure virDomainInterfaceStatsStruct

struct _virDomainInterfaceStats {
diff --git a/docs/devhelp/libvirt-virterror.html b/docs/devhelp/libvirt-virterror.html
index 2bade93cf2..2e0b97cd00 100644
--- a/docs/devhelp/libvirt-virterror.html
+++ b/docs/devhelp/libvirt-virterror.html
@@ -84,7 +84,7 @@ void	virConnResetLastError		(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-Epression code */
+    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 */
@@ -155,7 +155,7 @@ void	virConnResetLastError		(VIR_WAR_NO_NETWORK = 41 /* failed to start network */
     VIR_ERR_NO_DOMAIN = 42 /* domain not found or unexpectedly disappeared */
     VIR_ERR_NO_NETWORK = 43 /* network not found */
-    VIR_ERR_INVALID_MAC = 44 /* invalid MAC adress */
+    VIR_ERR_INVALID_MAC = 44 /* invalid MAC address */
     VIR_ERR_AUTH_FAILED = 45 /* authentication failed */
     VIR_ERR_INVALID_STORAGE_POOL = 46 /* invalid storage pool object */
     VIR_ERR_INVALID_STORAGE_VOL = 47 /* invalid storage vol object */
@@ -180,7 +180,7 @@ void	virConnResetLastError		(
virConnGetLastError ()
virErrorPtr	virConnGetLastError	(virConnectPtr conn)

 
Provide a pointer to the last error caught on that connection Simpler but may not be suitable for multithreaded accesses, in which case use virConnCopyLastError()

-
conn:pointer to the hypervisor connection
Returns:a pointer to the last error or NULL if none occured.
+
conn:pointer to the hypervisor connection
Returns:a pointer to the last error or NULL if none occurred.

virConnResetLastError ()

void	virConnResetLastError		(virConnectPtr conn)

Reset the last error caught on that connection

@@ -200,7 +200,7 @@ void virConnResetLastError (

virGetLastError ()

virErrorPtr	virGetLastError		(void)

Provide a pointer to the last error caught at the library level Simpler but may not be suitable for multithreaded accesses, in which case use virCopyLastError()

-
Returns:a pointer to the last error or NULL if none occured.
+
Returns:a pointer to the last error or NULL if none occurred.

virResetError ()

void	virResetError			(virErrorPtr err)

Reset the error being pointed to

diff --git a/docs/html/libvirt-libvirt.html b/docs/html/libvirt-libvirt.html index 9ab12aee6d..b0d0208749 100644 --- a/docs/html/libvirt-libvirt.html +++ b/docs/html/libvirt-libvirt.html @@ -30,6 +30,21 @@ The content of this structure is not made public by the API. 
Structure virSchedParameter
struct _virSchedParameter
 
Typedef virSchedParameter * virSchedParameterPtr
 
Enum virSchedParameterType
+
Structure virStoragePool
struct _virStoragePool
+The content of this structure is not made public by the API.
+
Enum virStoragePoolBuildFlags
+
Enum virStoragePoolDeleteFlags
+
Structure virStoragePoolInfo
struct _virStoragePoolInfo
+
Typedef virStoragePoolInfo * virStoragePoolInfoPtr
+
Typedef virStoragePool * virStoragePoolPtr
+
Enum virStoragePoolState
+
Structure virStorageVol
struct _virStorageVol
+The content of this structure is not made public by the API.
+
Enum virStorageVolDeleteFlags
+
Structure virStorageVolInfo
struct _virStorageVolInfo
+
Typedef virStorageVolInfo * virStorageVolInfoPtr
+
Typedef virStorageVol * virStorageVolPtr
+
Enum virStorageVolType
 
Structure virVcpuInfo
struct _virVcpuInfo
 
Typedef virVcpuInfo * virVcpuInfoPtr
 
Enum virVcpuState
@@ -45,12 +60,16 @@ int	virConnectAuthCallbackPtr	(int	virConnectGetVersion		(virConnectPtr conn, 
					 unsigned long * hvVer)
int	virConnectListDefinedDomains	(virConnectPtr conn, 
					 char ** const names, 
					 int maxnames)
int	virConnectListDefinedNetworks	(virConnectPtr conn, 
					 char ** const names, 
					 int maxnames)
+
int	virConnectListDefinedStoragePools	(virConnectPtr conn, 
						 char ** const names, 
						 int maxnames)
int	virConnectListDomains		(virConnectPtr conn, 
					 int * ids, 
					 int maxids)
int	virConnectListNetworks		(virConnectPtr conn, 
					 char ** const names, 
					 int maxnames)
+
int	virConnectListStoragePools	(virConnectPtr conn, 
					 char ** const names, 
					 int maxnames)
int	virConnectNumOfDefinedDomains	(virConnectPtr conn)
int	virConnectNumOfDefinedNetworks	(virConnectPtr conn)
+
int	virConnectNumOfDefinedStoragePools	(virConnectPtr conn)
int	virConnectNumOfDomains		(virConnectPtr conn)
int	virConnectNumOfNetworks		(virConnectPtr conn)
+
int	virConnectNumOfStoragePools	(virConnectPtr conn)
virConnectPtr	virConnectOpen		(const char * name)
virConnectPtr	virConnectOpenAuth	(const char * name, 
					 virConnectAuthPtr auth, 
					 int flags)
virConnectPtr	virConnectOpenReadOnly	(const char * name)
@@ -118,16 +137,51 @@ int virConnectAuthCallbackPtr (int virNodeGetCellsFreeMemory (virConnectPtr conn,
unsigned long long * freeMems,
int startCell,
int maxCells) 
unsigned long long	virNodeGetFreeMemory	(virConnectPtr conn)
int	virNodeGetInfo			(virConnectPtr conn, 
					 virNodeInfoPtr info)
+
int	virStoragePoolBuild		(virStoragePoolPtr pool, 
					 unsigned int flags)
+
int	virStoragePoolCreate		(virStoragePoolPtr pool, 
					 unsigned int flags)
+
virStoragePoolPtr	virStoragePoolCreateXML	(virConnectPtr conn, 
						 const char * xmlDesc, 
						 unsigned int flags)
+
virStoragePoolPtr	virStoragePoolDefineXML	(virConnectPtr conn, 
						 const char * xml, 
						 unsigned int flags)
+
int	virStoragePoolDelete		(virStoragePoolPtr pool, 
					 unsigned int flags)
+
int	virStoragePoolDestroy		(virStoragePoolPtr pool)
+
int	virStoragePoolFree		(virStoragePoolPtr pool)
+
int	virStoragePoolGetAutostart	(virStoragePoolPtr pool, 
					 int * autostart)
+
virConnectPtr	virStoragePoolGetConnect	(virStoragePoolPtr pool)
+
int	virStoragePoolGetInfo		(virStoragePoolPtr pool, 
					 virStoragePoolInfoPtr info)
+
const char *	virStoragePoolGetName	(virStoragePoolPtr pool)
+
int	virStoragePoolGetUUID		(virStoragePoolPtr pool, 
					 unsigned char * uuid)
+
int	virStoragePoolGetUUIDString	(virStoragePoolPtr pool, 
					 char * buf)
+
char *	virStoragePoolGetXMLDesc	(virStoragePoolPtr pool, 
					 unsigned int flags)
+
int	virStoragePoolListVolumes	(virStoragePoolPtr pool, 
					 char ** const names, 
					 int maxnames)
+
virStoragePoolPtr	virStoragePoolLookupByName	(virConnectPtr conn, 
							 const char * name)
+
virStoragePoolPtr	virStoragePoolLookupByUUID	(virConnectPtr conn, 
							 const unsigned char * uuid)
+
virStoragePoolPtr	virStoragePoolLookupByUUIDString	(virConnectPtr conn, 
							 const char * uuidstr)
+
virStoragePoolPtr	virStoragePoolLookupByVolume	(virStorageVolPtr vol)
+
int	virStoragePoolNumOfVolumes	(virStoragePoolPtr pool)
+
int	virStoragePoolRefresh		(virStoragePoolPtr pool, 
					 unsigned int flags)
+
int	virStoragePoolSetAutostart	(virStoragePoolPtr pool, 
					 int autostart)
+
int	virStoragePoolUndefine		(virStoragePoolPtr pool)
+
virStorageVolPtr	virStorageVolCreateXML	(virStoragePoolPtr pool, 
						 const char * xmldesc, 
						 unsigned int flags)
+
int	virStorageVolDelete		(virStorageVolPtr vol, 
					 unsigned int flags)
+
int	virStorageVolFree		(virStorageVolPtr vol)
+
virConnectPtr	virStorageVolGetConnect	(virStorageVolPtr vol)
+
int	virStorageVolGetInfo		(virStorageVolPtr vol, 
					 virStorageVolInfoPtr info)
+
const char *	virStorageVolGetKey	(virStorageVolPtr vol)
+
const char *	virStorageVolGetName	(virStorageVolPtr vol)
+
char *	virStorageVolGetPath		(virStorageVolPtr vol)
+
char *	virStorageVolGetXMLDesc		(virStorageVolPtr vol, 
					 unsigned int flags)
+
virStorageVolPtr	virStorageVolLookupByKey	(virConnectPtr conn, 
							 const char * key)
+
virStorageVolPtr	virStorageVolLookupByName	(virStoragePoolPtr pool, 
							 const char * name)
+
virStorageVolPtr	virStorageVolLookupByPath	(virConnectPtr conn, 
							 const char * path)

Description

Macro: LIBVIR_VERSION_NUMBER

#define LIBVIR_VERSION_NUMBER

Macro providing the version of the library as version * 1,000,000 + minor * 1000 + micro

-

Macro: VIR_COPY_CPUMAP

#define VIR_COPY_CPUMAP

This macro is to be used in conjonction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_COPY_CPUMAP macro extract the cpumap of the specified vcpu from cpumaps array and copy it into cpumap to be used later by virDomainPinVcpu() API.

-

Macro: VIR_CPU_MAPLEN

#define VIR_CPU_MAPLEN

This macro is to be used in conjonction with virDomainPinVcpu() API. It returns the length (in bytes) required to store the complete CPU map between a single virtual & all physical CPUs of a domain.

-

Macro: VIR_CPU_USABLE

#define VIR_CPU_USABLE

This macro is to be used in conjonction with virDomainGetVcpus() API. VIR_CPU_USABLE macro returns a non zero value (true) if the cpu is usable by the vcpu, and 0 otherwise.

+

Macro: VIR_COPY_CPUMAP

#define VIR_COPY_CPUMAP

This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_COPY_CPUMAP macro extract the cpumap of the specified vcpu from cpumaps array and copy it into cpumap to be used later by virDomainPinVcpu() API.

+

Macro: VIR_CPU_MAPLEN

#define VIR_CPU_MAPLEN

This macro is to be used in conjunction with virDomainPinVcpu() API. It returns the length (in bytes) required to store the complete CPU map between a single virtual & all physical CPUs of a domain.

+

Macro: VIR_CPU_USABLE

#define VIR_CPU_USABLE

This macro is to be used in conjunction with virDomainGetVcpus() API. VIR_CPU_USABLE macro returns a non zero value (true) if the cpu is usable by the vcpu, and 0 otherwise.

Macro: VIR_DOMAIN_SCHED_FIELD_LENGTH

#define VIR_DOMAIN_SCHED_FIELD_LENGTH

Macro providing the field length of virSchedParameter

-

Macro: VIR_GET_CPUMAP

#define VIR_GET_CPUMAP

This macro is to be used in conjonction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_GET_CPUMAP macro returns a pointer to the cpumap of the specified vcpu from cpumaps array.

-

Macro: VIR_NODEINFO_MAXCPUS

#define VIR_NODEINFO_MAXCPUS

This macro is to calculate the total number of CPUs supported but not neccessarily active in the host.

-

Macro: VIR_UNUSE_CPU

#define VIR_UNUSE_CPU

This macro is to be used in conjonction with virDomainPinVcpu() API. USE_CPU macro reset the bit (CPU not usable) of the related cpu in cpumap.

-

Macro: VIR_USE_CPU

#define VIR_USE_CPU

This macro is to be used in conjonction with virDomainPinVcpu() API. USE_CPU macro set the bit (CPU usable) of the related cpu in cpumap.

+

Macro: VIR_GET_CPUMAP

#define VIR_GET_CPUMAP

This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_GET_CPUMAP macro returns a pointer to the cpumap of the specified vcpu from cpumaps array.

+

Macro: VIR_NODEINFO_MAXCPUS

#define VIR_NODEINFO_MAXCPUS

This macro is to calculate the total number of CPUs supported but not necessary active in the host.

+

Macro: VIR_UNUSE_CPU

#define VIR_UNUSE_CPU

This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro reset the bit (CPU not usable) of the related cpu in cpumap.

+

Macro: VIR_USE_CPU

#define VIR_USE_CPU

This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro set the bit (CPU usable) of the related cpu in cpumap.

Macro: VIR_UUID_BUFLEN

#define VIR_UUID_BUFLEN

This macro provides the length of the buffer required for virDomainGetUUID()

Macro: VIR_UUID_STRING_BUFLEN

#define VIR_UUID_STRING_BUFLEN

This macro provides the length of the buffer required for virDomainGetUUIDString()

Structure virConnect

Structure virConnect
struct _virConnect {
@@ -165,10 +219,10 @@ The content of this structure is not made public by the API.
 }
A pointer to a virDomainBlockStats structure

Structure virDomainBlockStatsStruct

Structure virDomainBlockStatsStruct
struct _virDomainBlockStats {
-    long long	rd_req
-    long long	rd_bytes
-    long long	wr_req
-    long long	wr_bytes
+    long long	rd_req	: number of read requests
+    long long	rd_bytes	: number of read bytes
+    long long	wr_req	: number of write requests
+    long long	wr_bytes	: numbber of written bytes
     long long	errs	: In Xen this returns the mysterious 'oo_
 }

Enum virDomainCreateFlags

Enum virDomainCreateFlags {
     VIR_DOMAIN_NONE = 0
@@ -181,8 +235,8 @@ The content of this structure is not made public by the API.
     unsigned long long	cpuTime	: the CPU time used in nanoseconds
 }
a virDomainInfoPtr is a pointer to a virDomainInfo structure. - - A pointe to a virDomainInterfaceStats structure + + A pointer to a virDomainInterfaceStats structure

Structure virDomainInterfaceStatsStruct

Structure virDomainInterfaceStatsStruct
struct _virDomainInterfaceStats {
     long long	rx_bytes
     long long	rx_packets
@@ -238,6 +292,46 @@ The content of this structure is not made public by the API.
     VIR_DOMAIN_SCHED_FIELD_DOUBLE = 5 : double case
     VIR_DOMAIN_SCHED_FIELD_BOOLEAN = 6 : boolean(character) case
 }
+

Structure virStoragePool

Structure virStoragePool
struct _virStoragePool {
+The content of this structure is not made public by the API.
+}

Enum virStoragePoolBuildFlags

Enum virStoragePoolBuildFlags {
+    VIR_STORAGE_POOL_BUILD_NEW = 0 : Regular build from scratch
+    VIR_STORAGE_POOL_BUILD_REPAIR = 1 : Repair / reinitialize
+    VIR_STORAGE_POOL_BUILD_RESIZE = 2 : Extend existing pool
+}
+

Enum virStoragePoolDeleteFlags

Enum virStoragePoolDeleteFlags {
+    VIR_STORAGE_POOL_DELETE_NORMAL = 0 : Delete metadata only (fast)
+    VIR_STORAGE_POOL_DELETE_ZEROED = 1 : Clear all data to zeros (slow)
+}
+

Structure virStoragePoolInfo

Structure virStoragePoolInfo
struct _virStoragePoolInfo {
+    int	state	: virStoragePoolState flags
+    unsigned long long	capacity	: Logical size bytes
+    unsigned long long	allocation	: Current allocation bytes
+    unsigned long long	available	: Remaining free space bytes
+}
+ a virStoragePoolPtr is pointer to a virStoragePool private structure, this is the type used to reference a storage pool in the API. +

Enum virStoragePoolState

Enum virStoragePoolState {
+    VIR_STORAGE_POOL_INACTIVE = 0 : Not running
+    VIR_STORAGE_POOL_BUILDING = 1 : Initializing pool, not available
+    VIR_STORAGE_POOL_RUNNING = 2 : Running normally
+    VIR_STORAGE_POOL_DEGRADED = 3 : Running degraded
+}
+

Structure virStorageVol

Structure virStorageVol
struct _virStorageVol {
+The content of this structure is not made public by the API.
+}

Enum virStorageVolDeleteFlags

Enum virStorageVolDeleteFlags {
+    VIR_STORAGE_VOL_DELETE_NORMAL = 0 : Delete metadata only (fast)
+    VIR_STORAGE_VOL_DELETE_ZEROED = 1 : Clear all data to zeros (slow)
+}
+

Structure virStorageVolInfo

Structure virStorageVolInfo
struct _virStorageVolInfo {
+    int	type	: virStorageVolType flags
+    unsigned long long	capacity	: Logical size bytes
+    unsigned long long	allocation	: Current allocation bytes
+}
+ a virStorageVolPtr is pointer to a virStorageVol private structure, this is the type used to reference a storage volume in the API. +

Enum virStorageVolType

Enum virStorageVolType {
+    VIR_STORAGE_VOL_FILE = 0 : Regular file based volumes
+    VIR_STORAGE_VOL_BLOCK = 1 : Block based volumes
+}

Structure virVcpuInfo

Structure virVcpuInfo
struct _virVcpuInfo {
     unsigned int	number	: virtual CPU number
     int	state	: value from virVcpuState
@@ -269,19 +363,27 @@ int	virConnectAuthCallbackPtr	(
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: virConnectListDomains

int	virConnectListDomains		(virConnectPtr conn, 
					 int * ids, 
					 int maxids)

+
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)

+
Provides the list of names of inactive 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: virConnectListDomains
int	virConnectListDomains		(virConnectPtr conn, 
					 int * ids, 
					 int maxids)

 
Collect the list of active domains, and store their ID in @maxids

 
conn:pointer to the hypervisor connection
ids:array to collect the list of IDs of active domains
maxids:size of @ids
Returns:the number of domain found or -1 in case of error
Function: virConnectListNetworks
int	virConnectListNetworks		(virConnectPtr conn, 
					 char ** const names, 
					 int maxnames)

 
Collect the list of active networks, and store their names in @names

-
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: virConnectNumOfDefinedDomains
int	virConnectNumOfDefinedDomains	(virConnectPtr conn)

+
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.

 
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: virConnectNumOfDomains
int	virConnectNumOfDomains		(virConnectPtr conn)

+
conn:pointer to the hypervisor connection
Returns:the number of networks found or -1 in case of error
Function: virConnectNumOfDefinedStoragePools
int	virConnectNumOfDefinedStoragePools	(virConnectPtr conn)

+
Provides the number of inactive storage pools

+
conn:pointer to hypervisor connection
Returns:the number of pools found, or -1 on error
Function: virConnectNumOfDomains
int	virConnectNumOfDomains		(virConnectPtr conn)

 
Provides the number of active domains.

 
conn:pointer to the hypervisor connection
Returns:the number of domain found or -1 in case of error
Function: virConnectNumOfNetworks
int	virConnectNumOfNetworks		(virConnectPtr conn)

 
Provides the number of active networks.

-
conn:pointer to the hypervisor connection
Returns:the number of network found or -1 in case of error
Function: virConnectOpen
virConnectPtr	virConnectOpen		(const char * name)

+
conn:pointer to the hypervisor connection
Returns:the number of network found or -1 in case of error
Function: virConnectNumOfStoragePools
int	virConnectNumOfStoragePools	(virConnectPtr conn)

+
Provides the number of active storage pools

+
conn:pointer to hypervisor connection
Returns:the number of pools found, or -1 on error
Function: virConnectOpen
virConnectPtr	virConnectOpen		(const char * name)

 
This function should be called first to get a connection to the Hypervisor and xen store

 
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
Function: virConnectOpenAuth
virConnectPtr	virConnectOpenAuth	(const char * name, 
					 virConnectAuthPtr auth, 
					 int flags)

 
This function should be called first to get a connection to the Hypervisor. If neccessary, authentication will be performed fetching credentials via the callback

@@ -415,4 +517,74 @@ int	virConnectAuthCallbackPtr	(
conn:pointer to the hypervisor connection
Returns:the available free memory in kilobytes or 0 in case of error
Function: 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.
main menu
related links
Graphics and design by Diana Fong

+
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)

+
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)

+
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)

+
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)

+
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.

+
pool:pointer to storage pool
Returns:0 on success, or -1 if it could not be destroyed
Function: virStoragePoolFree
int	virStoragePoolFree		(virStoragePoolPtr pool)

+
Free a storage pool object, releasing all memory associated with it. Does not change the state of the pool on the host.

+
pool:pointer to storage pool
Returns:0 on success, or -1 if it could not be free'd.
Function: virStoragePoolGetAutostart
int	virStoragePoolGetAutostart	(virStoragePoolPtr pool, 
					 int * autostart)

+
Fetches the value of the autostart flag, which determines whether the pool is automatically started at boot time

+
pool:pointer to storage pool
autostart:location in which to store autostart flag
Returns:0 on success, -1 on failure
Function: virStoragePoolGetConnect
virConnectPtr	virStoragePoolGetConnect	(virStoragePoolPtr pool)

+
Provides the connection pointer associated with a storage pool. 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 pool object together.

+
pool:pointer to a poool
Returns:the virConnectPtr or NULL in case of failure.
Function: virStoragePoolGetInfo
int	virStoragePoolGetInfo		(virStoragePoolPtr pool, 
					 virStoragePoolInfoPtr info)

+
Get volatile information about the storage pool such as free space / usage summary

+
pool:pointer to storage pool
info:pointer at which to store info
Returns:0 on success, or -1 on failure.
Function: virStoragePoolGetName
const char *	virStoragePoolGetName	(virStoragePoolPtr pool)

+
Fetch the locally unique name of the storage pool

+
pool:pointer to storage pool
Returns:the name of the pool, or NULL on error
Function: virStoragePoolGetUUID
int	virStoragePoolGetUUID		(virStoragePoolPtr pool, 
					 unsigned char * uuid)

+
Fetch the globally unique ID of the storage pool

+
pool:pointer to storage pool
uuid:buffer of VIR_UUID_BUFLEN bytes in size
Returns:0 on success, or -1 on error;
Function: virStoragePoolGetUUIDString
int	virStoragePoolGetUUIDString	(virStoragePoolPtr pool, 
					 char * buf)

+
Fetch the globally unique ID of the storage pool as a string

+
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)

+
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

+
conn:pointer to hypervisor connection
name:name of pool to fetch
Returns:a virStoragePoolPtr object, or NULL if no matching pool is found
Function: virStoragePoolLookupByUUID
virStoragePoolPtr	virStoragePoolLookupByUUID	(virConnectPtr conn, 
							 const unsigned char * uuid)

+
Fetch a storage pool based on its globally unique id

+
conn:pointer to hypervisor connection
uuid:globally unique id of pool to fetch
Returns:a virStoragePoolPtr object, or NULL if no matching pool is found
Function: virStoragePoolLookupByUUIDString
virStoragePoolPtr	virStoragePoolLookupByUUIDString	(virConnectPtr conn, 
							 const char * uuidstr)

+
Fetch a storage pool based on its globally unique id

+
conn:pointer to hypervisor connection
uuidstr:globally unique id of pool to fetch
Returns:a virStoragePoolPtr object, or NULL if no matching pool is found
Function: virStoragePoolLookupByVolume
virStoragePoolPtr	virStoragePoolLookupByVolume	(virStorageVolPtr vol)

+
Fetch a storage pool which contains a particular volume

+
vol:pointer to storage volume
Returns:a virStoragePoolPtr object, or NULL if no matching pool is found
Function: virStoragePoolNumOfVolumes
int	virStoragePoolNumOfVolumes	(virStoragePoolPtr pool)

+
Fetch the number of storage volumes within a pool

+
pool:pointer to storage pool
Returns:the number of storage pools, or -1 on failure
Function: virStoragePoolRefresh
int	virStoragePoolRefresh		(virStoragePoolPtr pool, 
					 unsigned int flags)

+
Request that the pool refresh its list of volumes. This may involve communicating with a remote server, and/or initializing new devices at the OS layer

+
pool:pointer to storage pool
flags:flags to control refresh behaviour (currently unused, use 0)
Returns:0 if the volume list was refreshed, -1 on failure
Function: virStoragePoolSetAutostart
int	virStoragePoolSetAutostart	(virStoragePoolPtr pool, 
					 int autostart)

+
Sets the autostart flag

+
pool:pointer to storage pool
autostart:new flag setting
Returns:0 on success, -1 on failure
Function: virStoragePoolUndefine
int	virStoragePoolUndefine		(virStoragePoolPtr pool)

+
Undefine an inactive storage pool

+
pool:pointer to storage pool
Returns:a virStoragePoolPtr object, or NULL if creation failed
Function: virStorageVolCreateXML
virStorageVolPtr	virStorageVolCreateXML	(virStoragePoolPtr pool, 
						 const char * xmldesc, 
						 unsigned int flags)

+
Create a storage volume within a pool based on an XML description. Not all pools support creation of volumes

+
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)

+
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.

+
vol:pointer to a poool
Returns:the virConnectPtr or NULL in case of failure.
Function: virStorageVolGetInfo
int	virStorageVolGetInfo		(virStorageVolPtr vol, 
					 virStorageVolInfoPtr info)

+
Fetches volatile information about the storage volume such as its current allocation

+
vol:pointer to storage volume
info:pointer at which to store info
Returns:0 on success, or -1 on failure
Function: virStorageVolGetKey
const char *	virStorageVolGetKey	(virStorageVolPtr vol)

+
Fetch the storage volume key. This is globally unique, so the same volume will hve the same key no matter what host it is accessed from

+
vol:pointer to storage volume
Returns:the volume key, or NULL on error
Function: virStorageVolGetName
const char *	virStorageVolGetName	(virStorageVolPtr vol)

+
Fetch the storage volume name. This is unique within the scope of a pool

+
vol:pointer to storage volume
Returns:the volume name, or NULL on error
Function: virStorageVolGetPath
char *	virStorageVolGetPath		(virStorageVolPtr vol)

+
Fetch the storage volume path. Depending on the pool configuration this is either persistent across hosts, or dynamically assigned at pool startup. Consult pool documentation for information on getting the persistent naming

+
vol:pointer to storage volume
Returns:the storage volume path, or NULL on error
Function: virStorageVolGetXMLDesc
char *	virStorageVolGetXMLDesc		(virStorageVolPtr vol, 
					 unsigned int flags)

+
Fetch an XML document describing all aspects of the storage volume

+
vol:pointer to storage volume
flags:flags for XML generation (unused, pass 0)
Returns:the XML document, or NULL on error
Function: virStorageVolLookupByKey
virStorageVolPtr	virStorageVolLookupByKey	(virConnectPtr conn, 
							 const char * key)

+
Fetch a pointer to a storage volume based on its globally unique key

+
conn:pointer to hypervisor connection
key:globally unique key
Returns:a storage volume, or NULL if not found / error
Function: virStorageVolLookupByName
virStorageVolPtr	virStorageVolLookupByName	(virStoragePoolPtr pool, 
							 const char * name)

+
Fetch a pointer to a storage volume based on its name within a pool

+
pool:pointer to storage pool
name:name of storage volume
Returns:a storage volume, or NULL if not found / error
Function: virStorageVolLookupByPath
virStorageVolPtr	virStorageVolLookupByPath	(virConnectPtr conn, 
							 const char * path)

+
Fetch a pointer to a storage volume based on its locally (host) unique path

+
conn:pointer to hypervisor connection
path:locally unique path
Returns:a storage volume, or NULL if not found / error
main menu
related links
Graphics and design by Diana Fong

diff --git a/docs/html/libvirt-virterror.html b/docs/html/libvirt-virterror.html
index 5c59a31e2f..f8be500dc0 100644
--- a/docs/html/libvirt-virterror.html
+++ b/docs/html/libvirt-virterror.html
@@ -37,7 +37,7 @@ void	virErrorFunc			(void * userData, 
					 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-Epression code
+    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
@@ -50,6 +50,7 @@ void	virErrorFunc			(void * userData, 
					 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_STORAGE = 17 : Error from storage driver
 }
 
Enum virErrorLevel
Enum virErrorLevel {
     VIR_ERR_NONE = 0
@@ -101,14 +102,19 @@ void	virErrorFunc			(void * userData, 
					 VIR_WAR_NO_NETWORK = 41 : failed to start network
     VIR_ERR_NO_DOMAIN = 42 : domain not found or unexpectedly disappeared
     VIR_ERR_NO_NETWORK = 43 : network not found
-    VIR_ERR_INVALID_MAC = 44 : invalid MAC adress
+    VIR_ERR_INVALID_MAC = 44 : invalid MAC address
     VIR_ERR_AUTH_FAILED = 45 : authentication failed
+    VIR_ERR_INVALID_STORAGE_POOL = 46 : invalid storage pool object
+    VIR_ERR_INVALID_STORAGE_VOL = 47 : invalid storage vol object
+    VIR_WAR_NO_STORAGE = 48 : failed to start storage
+    VIR_ERR_NO_STORAGE_POOL = 49 : storage pool not found
+    VIR_ERR_NO_STORAGE_VOL = 50 : storage pool not found
 }
 
Function: virConnCopyLastError
int	virConnCopyLastError		(virConnectPtr conn, 
					 virErrorPtr to)

 
Copy the content of the last error caught on that connection One will need to free the result with virResetError()

 
conn:pointer to the hypervisor connection
to:target to receive the copy
Returns:0 if no error was found and the error code otherwise and -1 in case of parameter error.
Function: virConnGetLastError
virErrorPtr	virConnGetLastError	(virConnectPtr conn)

 
Provide a pointer to the last error caught on that connection Simpler but may not be suitable for multithreaded accesses, in which case use virConnCopyLastError()

-
conn:pointer to the hypervisor connection
Returns:a pointer to the last error or NULL if none occured.
Function: virConnResetLastError
void	virConnResetLastError		(virConnectPtr conn)

+
conn:pointer to the hypervisor connection
Returns:a pointer to the last error or NULL if none occurred.
Function: virConnResetLastError
void	virConnResetLastError		(virConnectPtr conn)

 
Reset the last error caught on that connection

 
conn:pointer to the hypervisor connection
Function: virConnSetErrorFunc
void	virConnSetErrorFunc		(virConnectPtr conn, 
					 void * userData, 
					 virErrorFunc handler)

 
Set a connection error handling function, if @handler is NULL it will reset to default which is to pass error back to the global library handler.

@@ -121,7 +127,7 @@ void	virErrorFunc			(void * userData, 
					 
userData:user provided data for the error callback
error:the error being raised.


 
Function: virGetLastError
virErrorPtr	virGetLastError		(void)

 
Provide a pointer to the last error caught at the library level Simpler but may not be suitable for multithreaded accesses, in which case use virCopyLastError()

-
Returns:a pointer to the last error or NULL if none occured.
Function: virResetError
void	virResetError			(virErrorPtr err)

+
Returns:a pointer to the last error or NULL if none occurred.
Function: virResetError
void	virResetError			(virErrorPtr err)

 
Reset the error being pointed to

 
err:pointer to the virError to clean up
Function: virResetLastError
void	virResetLastError		(void)

 
Reset the last error caught at the library level.

diff --git a/docs/libvirt-api.xml b/docs/libvirt-api.xml
index aaba21772c..464e5d15dc 100644
--- a/docs/libvirt-api.xml
+++ b/docs/libvirt-api.xml
@@ -336,18 +336,18 @@
       Macro providing the version of the library as version * 1,000,000 + minor * 1000 + micro
     
     
-      This macro is to be used in conjonction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_COPY_CPUMAP macro extract the cpumap of the specified vcpu from cpumaps array and copy it into cpumap to be used later by virDomainPinVcpu() API.
+      This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_COPY_CPUMAP macro extract the cpumap of the specified vcpu from cpumaps array and copy it into cpumap to be used later by virDomainPinVcpu() API.
       
       
       
       
     
     
-      This macro is to be used in conjonction with virDomainPinVcpu() API. It returns the length (in bytes) required to store the complete CPU map between a single virtual & all physical CPUs of a domain.
+      This macro is to be used in conjunction with virDomainPinVcpu() API. It returns the length (in bytes) required to store the complete CPU map between a single virtual & all physical CPUs of a domain.
       
     
     
-      This macro is to be used in conjonction with virDomainGetVcpus() API. VIR_CPU_USABLE macro returns a non zero value (true) if the cpu is usable by the vcpu, and 0 otherwise.
+      This macro is to be used in conjunction with virDomainGetVcpus() API. VIR_CPU_USABLE macro returns a non zero value (true) if the cpu is usable by the vcpu, and 0 otherwise.
       
       
       
@@ -357,22 +357,22 @@
       Macro providing the field length of virSchedParameter
     
     
-      This macro is to be used in conjonction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_GET_CPUMAP macro returns a pointer to the cpumap of the specified vcpu from cpumaps array.
+      This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_GET_CPUMAP macro returns a pointer to the cpumap of the specified vcpu from cpumaps array.
       
       
       
     
     
-      This macro is to calculate the total number of CPUs supported but not neccessarily active in the host.
+      This macro is to calculate the total number of CPUs supported but not necessary active in the host.
       
     
     
-      This macro is to be used in conjonction with virDomainPinVcpu() API. USE_CPU macro reset the bit (CPU not usable) of the related cpu in cpumap.
+      This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro reset the bit (CPU not usable) of the related cpu in cpumap.
       
       
     
     
-      This macro is to be used in conjonction with virDomainPinVcpu() API. USE_CPU macro set the bit (CPU usable) of the related cpu in cpumap.
+      This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro set the bit (CPU usable) of the related cpu in cpumap.
       
       
     
@@ -421,7 +421,7 @@
     
     
     
-    
+    
     
     
     
@@ -469,7 +469,7 @@
     
     
     
-    
+    
     
     
     
@@ -524,10 +524,10 @@
       A pointer to a virDomainBlockStats structure
     
     
-      
-      
-      
-      
+      
+      
+      
+      
       
     
     
@@ -542,7 +542,7 @@
       a virDomainInfoPtr is a pointer to a virDomainInfo structure.
     
     
-      A pointe to a virDomainInterfaceStats structure
+      A pointer to a virDomainInterfaceStats structure
     
     
       
@@ -646,7 +646,7 @@
     
     
       Provide a pointer to the last error caught on that connection Simpler but may not be suitable for multithreaded accesses, in which case use virConnCopyLastError()
-      
+      
       
     
     
@@ -1068,7 +1068,7 @@
     
     
       Provide a pointer to the last error caught at the library level Simpler but may not be suitable for multithreaded accesses, in which case use virCopyLastError()
-      
+      
     
     
       Provides two information back, @libVer is the version of the library while @typeVer will be the version of the hypervisor type @type against which the library was compiled. If @type is NULL, "Xen" is assumed, if @type is unknown or not availble, an error code will be returned and @typeVer will be 0.
diff --git a/docs/libvirt-refs.xml b/docs/libvirt-refs.xml
index 51e65b6287..82cffaf8db 100644
--- a/docs/libvirt-refs.xml
+++ b/docs/libvirt-refs.xml
@@ -2192,6 +2192,7 @@
         
         
           
+          
           
           
           
@@ -2370,7 +2371,7 @@
           
           
         
-        
+        
           
           
           
@@ -3591,12 +3592,12 @@
           
           
         
-        
-          
-        
         
           
         
+        
+          
+        
         
           
           
@@ -3655,6 +3656,9 @@
           
           
         
+        
+          
+        
       
       
         
@@ -3666,7 +3670,7 @@
         
           
         
-        
+        
           
           
         
@@ -3926,6 +3930,9 @@
         
           
         
+        
+          
+        
         
           
           
@@ -3998,6 +4005,9 @@
         
           
         
+        
+          
+        
         
           
           
@@ -4979,12 +4989,18 @@
         
           
         
+        
+          
+        
         
           
           
           
           
         
+        
+          
+        
         
           
         
diff --git a/include/libvirt/libvirt.h b/include/libvirt/libvirt.h
index 1e51365805..f304d89ef5 100644
--- a/include/libvirt/libvirt.h
+++ b/include/libvirt/libvirt.h
@@ -201,10 +201,10 @@ int	virDomainSetSchedulerParameters	(virDomainPtr domain,
 typedef struct _virDomainBlockStats virDomainBlockStatsStruct;
 
 struct _virDomainBlockStats {
-  long long rd_req;
-  long long rd_bytes;
-  long long wr_req;
-  long long wr_bytes;
+  long long rd_req; /* number of read requests */
+  long long rd_bytes; /* number of read bytes */
+  long long wr_req; /* number of write requests */
+  long long wr_bytes; /* numbber of written bytes */
   long long errs;   /* In Xen this returns the mysterious 'oo_req'. */
 };
 
@@ -261,7 +261,7 @@ virDomainPtr virDomainMigrate (virDomainPtr domain, virConnectPtr dconn,
  * @nodeinfo: virNodeInfo instance
  *
  * This macro is to calculate the total number of CPUs supported
- * but not necessarily active in the host.
+ * but not necessary active in the host.
  */
 
 
diff --git a/include/libvirt/libvirt.h.in b/include/libvirt/libvirt.h.in
index 2963f0d92c..1202ee9ed3 100644
--- a/include/libvirt/libvirt.h.in
+++ b/include/libvirt/libvirt.h.in
@@ -201,10 +201,10 @@ int	virDomainSetSchedulerParameters	(virDomainPtr domain,
 typedef struct _virDomainBlockStats virDomainBlockStatsStruct;
 
 struct _virDomainBlockStats {
-  long long rd_req;
-  long long rd_bytes;
-  long long wr_req;
-  long long wr_bytes;
+  long long rd_req; /* number of read requests */
+  long long rd_bytes; /* number of read bytes */
+  long long wr_req; /* number of write requests */
+  long long wr_bytes; /* numbber of written bytes */
   long long errs;   /* In Xen this returns the mysterious 'oo_req'. */
 };