Re: [libvirt] [PATCH 1/2] virsh: man: Document quirks of device-detach and friends

Mention that successful return does not equal to device being detached similarly as we do at the API level. Signed-off-by: Peter Krempa <pkrempa(a)redhat.com&gt; --- tools/virsh.pod | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/tools/virsh.pod b/tools/virsh.pod index 66e2bf24ec..39ff8cd7c9 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -3264,6 +3264,16 @@ or attempting to detach a device that is not present in the domain XML, but shares some specific attributes with one that is present, may lead to unexpected results. +B<Quirk>: Device unplug is asynchronous in most cases and requires guest +cooperation. This means that it's up to the discretion of the guest to disallow +or delay the unplug arbitrarily. As the libvirt API used in this command was +designed as synchronous it returns success after some timeout even if the device +was not unplugged yet to allow further interactions with the domain if the guest +e.g. if the guest is unresponsive. Callers which need to make sure that the +device was unplugged can use libvirt events (see virsh event) to be notified +when the device is removed. Note that the even may arrive before the command

+returns.