From: Peter Krempa <pkrempa@redhat.com>
Date: Mon, 15 Sep 2014 15:17:17 +0000 (+0200)
Subject: lib: Document that virConnectGetAllDomainStats may omit some stats fields
X-Git-Tag: CVE-2014-3633~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a6500ee4f2f0db3fb8c408075b7dbcd77f7669d2;p=thirdparty%2Flibvirt.git

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 92f4c217b5..98f7cc84ac 100644
--- 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.
  *