[libvirt] [PATCH] Clarify documentation on possible return values in case of errors

[Eric Blake]

On 01/09/2014 12:07 AM, Claudio Bley wrote:
> 
> Signed-off-by: Claudio Bley <cbley at av-test.de>
> ---
>  src/libvirt.c |   10 ++++++----
>  1 file changed, 6 insertions(+), 4 deletions(-)
> 
> diff --git a/src/libvirt.c b/src/libvirt.c
> index ffd4f8e..73972f2 100644
> --- a/src/libvirt.c
> +++ b/src/libvirt.c
> @@ -14502,8 +14502,8 @@ virNodeDeviceGetName(virNodeDevicePtr dev)
>   *
>   * Accessor for the parent of the device
>   *
> - * Returns the name of the device's parent, or NULL if the
> - * device has no parent.
> + * Returns the name of the device's parent, or NULL if an
> + * error occurred or when the device has no parent.

Hmm.  When there is no parent, we actually DO raise an error, but it is
currently VIR_ERR_INTERNAL_ERROR, and that's wrong.  What we SHOULD do
is raise a particular error that distinguishes this from other failures,
the same as virDomainSnapshotGetParent raises VIR_ERR_NO_DOMAIN_SNAPSHOT
for a missing parent, compared to other errors for failure to look up a
snapshot or out of memory.

Your doc patch is right, but we should do a followup to clean up the code.

-- 
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: 604 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20140110/986951ae/attachment-0001.sig>