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>
This commit is contained in:
Michal Privoznik 2018-07-04 13:17:58 +02:00
parent 2647a36367
commit 7152b12c45

View File

@ -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.
*/