From: Michal Privoznik <mprivozn@redhat.com>
Date: Mon, 29 Jun 2020 12:55:54 +0000 (+0200)
Subject: virConnectGetAllDomainStats: Document two vcpu stats
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=201f8d1876136b0693505614efa3c9d113aff0bb;p=libvirt.git

virConnectGetAllDomainStats: Document two vcpu stats

When introducing vcpu.<num>.wait (v1.3.2-rc1~301) and
vcpu.<num>.halted (v2.4.0-rc1~36) the documentation was
not written.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Erik Skultety <eskultet@redhat.com>
---

diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index 60b5e65fc3..52ce3ef798 100644
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -11493,6 +11493,11 @@ virConnectGetDomainCapabilities(virConnectPtr conn,
  *                          from virVcpuState enum.
  *     "vcpu.<num>.time" - virtual cpu time spent by virtual CPU <num>
  *                         as unsigned long long.
+ *     "vcpu.<num>.wait" - time the vCPU <num> wants to run, but the host
+ *                         scheduler has something else running ahead of it.
+ *     "vcpu.<num>.halted" - virtual CPU <num> is halted, may indicate the
+ *                           processor is idle or even disabled, depending
+ *                           on the architecture)
  *
  * VIR_DOMAIN_STATS_INTERFACE:
  *     Return network interface statistics (from domain point of view).