From f0b22ebea4aeeb6bfe5c56496e2253961eef9c4b Mon Sep 17 00:00:00 2001 From: Eric Blake Date: Sat, 28 Jan 2012 07:29:10 -0700 Subject: [PATCH] docs: tweak recent suspend API additions * src/libvirt.c (virDomainPMSuspendForDuration): Clarify usage. --- src/libvirt.c | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/src/libvirt.c b/src/libvirt.c index 9de64fd4ba..7060f5a879 100644 --- a/src/libvirt.c +++ b/src/libvirt.c @@ -2435,14 +2435,17 @@ error: /** * virDomainPMSuspendForDuration: * @dom: a domain object - * @target: an OR'ed set of virNodeSuspendTarget - * @duration: currently unused, pass 0 - * @flags: ditto + * @target: a value from virNodeSuspendTarget + * @duration: duration in seconds to suspend, or 0 for indefinite + * @flags: extra flags; not used yet, so callers should always pass 0 * - * Attempt to suspend given domain. However, more - * states are supported than in virDomainSuspend. + * Attempt to have the guest enter the given @target power management + * suspension level. If @duration is non-zero, also schedule the guest to + * resume normal operation after that many seconds, if nothing else has + * resumed it earlier. Some hypervisors require that @duration be 0, for + * an indefinite suspension. * - * Dependent on hypervisor used, this may require + * Dependent on hypervisor used, this may require a * guest agent to be available, e.g. QEMU. * * Returns: 0 on success,