From 46135dd40fbe112211c4ed7f6d9a6cc7b4001af1 Mon Sep 17 00:00:00 2001 From: Peter Krempa Date: Fri, 16 Aug 2019 11:28:03 +0200 Subject: [PATCH] util: storagefile: Clarify docs for '@report_broken' of virStorageFileGetMetadata MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- src/util/virstoragefile.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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. */