[libvirt] [PATCH 7/7] libvirt-domain: Document interface stats POV

[Michal Privoznik]

On 10/05/2017 12:49 AM, John Ferlan wrote:
> 
> 
> On 10/02/2017 11:05 AM, Michal Privoznik wrote:
>> 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 at redhat.com>
>> ---
>>  src/libvirt-domain.c | 4 +++-
>>  1 file changed, 3 insertions(+), 1 deletion(-)
>>
> 
> Maybe we should be even more explicit vis-a-vis when certain types of
> interface stats are swapped - direct & ethernet keep the same/current
> view, but every other type is changing. I know/understand this is a
> "tricky" and "slippery" slope in order to keep up with in the future,
> but I think some wording could be generated that would suffice

I'm not fully convinced about this. I mean, it's just our implementation
detail that we read stats from the host and therefore have to swap
fields sometimes. The whole point of this series is that users reading
stats do not need to fix/swap the fields themselves depending on the
interface type.

> 
> Also a followup patch should modify docs/news.xml!

Ah right. I'll send it right away.

Michal