libvirt-domain: Document interface stats POV

Interestingly enough, we don't document the point of view of the
interface statistics. Therefore it's unknown to users if for
instance rx_packets is the number of packets received by domain or
received by host (from domain). Document this explicitly.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
This commit is contained in:
Michal Privoznik 2017-10-02 16:31:30 +02:00
parent cea3715b2e
commit 57b17c8d84

View File

@ -5523,6 +5523,8 @@ virDomainBlockStatsFlags(virDomainPtr dom,
* as -1, which indicates that the hypervisor does not support
* that particular statistic.
*
* The returned stats are from domain's point of view.
*
* Returns: 0 in case of success or -1 in case of failure.
*/
int
@ -11301,7 +11303,7 @@ virConnectGetDomainCapabilities(virConnectPtr conn,
* as unsigned long long.
*
* VIR_DOMAIN_STATS_INTERFACE:
* Return network interface statistics.
* Return network interface statistics (from domain point of view).
* The typed parameter keys are in this format:
*
* "net.count" - number of network interfaces on this domain