From 63fd27cfa35f39b32692b9c66e59c4d157ce8806 Mon Sep 17 00:00:00 2001 From: Jiri Denemark Date: Wed, 25 Nov 2015 16:39:17 +0100 Subject: [PATCH] Enhance documentation of virDomainDetachDevice Link it to virDomainDetachDeviceFlags. https://bugzilla.redhat.com/show_bug.cgi?id=1257280 Signed-off-by: Jiri Denemark --- src/libvirt-domain.c | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c index 7cfbe586c3..7cfc4d2ac3 100644 --- a/src/libvirt-domain.c +++ b/src/libvirt-domain.c @@ -8392,19 +8392,10 @@ virDomainAttachDeviceFlags(virDomainPtr domain, * @domain: pointer to domain object * @xml: pointer to XML description of one device * - * Destroy a virtual device attachment to backend. This function, - * having hot-unplug semantics, is only allowed on an active domain. + * This is an equivalent of virDomainDetachDeviceFlags() when called with + * @flags parameter set to VIR_DOMAIN_AFFECT_LIVE. * - * Be aware that hotplug changes might not persist across a domain going - * into S4 state (also known as hibernation) unless you also modify the - * persistent domain definition. - * - * The supplied XML description of the device should be as specific - * as its definition in the domain XML. The set of attributes used - * to match the device are internal to the drivers. Using a partial definition, - * 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. + * See virDomainDetachDeviceFlags() for more details. * * Returns 0 in case of success, -1 in case of failure. */