mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2025-01-22 04:25:18 +00:00
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 <pkrempa@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
parent
9467c37e96
commit
46135dd40f
@ -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.
|
||||
*/
|
||||
|
Loading…
x
Reference in New Issue
Block a user