From: Peter Krempa Date: Fri, 16 Aug 2019 09:28:03 +0000 (+0200) Subject: util: storagefile: Clarify docs for '@report_broken' of virStorageFileGetMetadata X-Git-Tag: v5.7.0-rc1~64 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=46135dd40fbe112211c4ed7f6d9a6cc7b4001af1;p=thirdparty%2Flibvirt.git util: storagefile: Clarify docs for '@report_broken' of virStorageFileGetMetadata virStorageFileGetMetadata does not report error if we can't interrogate the file somehow. Clarify this in the description of the @report_broken flag as it implies we should report an error in that case. The problem is that we don't know whether there's a problem and unfortunately just offload it to qemu. Signed-off-by: Peter Krempa Reviewed-by: Ján Tomko --- diff --git a/src/util/virstoragefile.c b/src/util/virstoragefile.c index b0e87169a3..66cde582fc 100644 --- a/src/util/virstoragefile.c +++ b/src/util/virstoragefile.c @@ -4990,7 +4990,8 @@ virStorageFileGetMetadataRecurse(virStorageSourcePtr src, * other non-raw format at will. * * If @report_broken is true, the whole function fails with a possibly sane - * error instead of just returning a broken chain. + * error instead of just returning a broken chain. Note that the inability for + * libvirt to traverse a given source is not considered an error. * * Caller MUST free result after use via virObjectUnref. */