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.

diff --git a/src/libvirt.c b/src/libvirt.c
index 92f4c217b58ef1cbf01c1e64df29498582d67caf..98f7cc84acb5cee428ba59111694a81e2433b32b 100644 (file)
--- a/src/libvirt.c
+++ b/src/libvirt.c
@@ -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.
  *