lib: Document that virConnectGetAllDomainStats may omit some stats fields

Add a note to make the users aware that some stats groups or fields may
be missing in certain cases.
This commit is contained in:
Peter Krempa 2014-09-15 17:17:17 +02:00
parent b7dd3d9b46
commit a6500ee4f2
1 changed files with 5 additions and 0 deletions

View File

@ -21657,6 +21657,11 @@ virConnectGetDomainCapabilities(virConnectPtr conn,
* "block.<num>.errors" - Xen only: the 'oo_req' value as
* unsigned long long.
*
* Note that entire stats groups or individual stat fields may be missing from
* the output in case they are not supported by the given hypervisor, are not
* applicable for the current state of the guest domain, or their retrieval
* was not successful.
*
* Using 0 for @stats returns all stats groups supported by the given
* hypervisor.
*