]> xenbits.xensource.com Git - people/liuw/libxenctrl-split/libvirt.git/commit
getstats: improve documentation
authorEric Blake <eblake@redhat.com>
Fri, 5 Dec 2014 04:39:55 +0000 (21:39 -0700)
committerEric Blake <eblake@redhat.com>
Mon, 8 Dec 2014 16:45:55 +0000 (09:45 -0700)
commitf301fe77c63b29b90ad478e328fb20394251f6a6
treebbaeb1f3d987def2755d6f80f3036819ce81849e
parent2f61602edbc96309116d7c8eff61e6a37ff4d253
getstats: improve documentation

At least with 'virsh domstats --block' on an offline domain, we
currently output no stats even though we recognize the stat
category.  Although a later patch will improve this situation,
it is better to document that this is expected behavior.

Also, while the current implementation rejects filtering flags
for virDomainListGetStats, this limitation may be lifted in the
future and we do not enforce it at the API level.

* src/libvirt-domain.c (virConnectGetAllDomainStats): Document
that recognized stats might not be reported.
(virDomainListGetStats): Likewise, and tweak filtering documentation.

Signed-off-by: Eric Blake <eblake@redhat.com>
src/libvirt-domain.c