src: Mention DEVICE_REMOVAL_FAILED event in virDomainDetachDeviceAlias docs

https://bugzilla.redhat.com/show_bug.cgi?id=1598087

We are mentioning the positive outcome of the function and not
the case when live detaching a device is denied and event is
issued.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Jiri Denemark <jdenemar@redhat.com>

diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index c71f2e68773b56e388aaf3a05c015bcaf7b4f7a7..ab7266dc19ed8d5abe56df790c45113a1372ad8b 100644 (file)
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -8365,7 +8365,9 @@ virDomainUpdateDeviceFlags(virDomainPtr domain,
  * asynchronous - it returns immediately after sending the detach
  * request to the hypervisor. It's caller's responsibility to
  * wait for VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED event to signal
- * actual device removal.
+ * actual device removal or for
+ * VIR_DOMAIN_EVENT_ID_DEVICE_REMOVAL_FAILED to signal rejected
+ * device removal.
  *
  * Returns 0 in case of success, -1 in case of failure.
  */