]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
manpage: virsh: Note that 'virsh undefine --remove-all-storage' doesn't remove backin...
authorPeter Krempa <pkrempa@redhat.com>
Thu, 7 Sep 2023 11:03:14 +0000 (13:03 +0200)
committerPeter Krempa <pkrempa@redhat.com>
Mon, 11 Sep 2023 11:15:01 +0000 (13:15 +0200)
Removing a backing image could break other image chains as it's
theoretically possible to share backing chains.

As --storage/--remove-all-storage is fully implemented in virsh as a
helper option, which enumerates and deletes VM's volumes. We do not plan
to make it any more complicated.

Document that backing chains are not removed.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
docs/manpages/virsh.rst

index 91e1d5de37d46ce1ea2edac1346e9abeea494cba..4ae3bb4d939ad5250720f6eb33ccaf6c7f03ae9a 100644 (file)
@@ -4614,12 +4614,13 @@ undefined; if not all of the requested volumes could be deleted, the
 error message indicates what still remains behind. If a volume path is not
 found in the domain definition, it's treated as if the volume was successfully
 deleted. Only volumes managed by libvirt in storage pools can be removed this
-way.
+way. Note that this also removes only the top level image of a backing chain,
+any backing stores of the image are kept as they may be shared.
 (See ``domblklist`` for list of target names associated to a domain).
 Example: --storage vda,/path/to/storage.img
 
 The *--remove-all-storage* flag specifies that all of the domain's storage
-volumes should be deleted.
+volumes should be deleted as if they were specified via *--storage*.
 
 The *--delete-storage-volume-snapshots* (previously *--delete-snapshots*)
 flag specifies that any snapshots associated with