[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[libvirt] [PATCHv6 10/11] 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.
---
 src/libvirt.c | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/libvirt.c b/src/libvirt.c
index 03f7e5b..b3ddf95 100644
--- a/src/libvirt.c
+++ b/src/libvirt.c
@@ -21657,6 +21657,11 @@ virConnectGetDomainCapabilities(virConnectPtr conn,
  * "block.<num>.allocation" - offset of the highest written sector
  *                            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.
  *
-- 
2.1.0


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]