[libvirt] [PATCHv6 10/11] lib: Document that virConnectGetAllDomainStats may omit some stats fields

[Eric Blake]

On 09/15/2014 09:42 AM, Peter Krempa wrote:
> 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(+)
> 

ACK.

> 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.

Depending on which grammar expert you ask, some people prefer "a, b, or
c" while others prefer "a, b or c" when listing three or more things
(the use of a comma before the conjunction that lists the last element
of a list).  I'm in the former group, but not strongly enough to request
that others change their habits.  So up to you if you want to add a
comma before that last "or".

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 539 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20140915/c0cbe60f/attachment-0001.sig>