openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: tweak recent suspend API additions 

* src/libvirt.c (virDomainPMSuspendForDuration): Clarify usage.
This commit is contained in:
Eric Blake 2012-01-28 07:29:10 -07:00
parent e1eea7470b
commit f0b22ebea4
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/libvirt.c
View File

@ -2435,14 +2435,17 @@ error:
/** /**
* virDomainPMSuspendForDuration: * virDomainPMSuspendForDuration:
* @dom: a domain object * @dom: a domain object
* @target: an OR'ed set of virNodeSuspendTarget * @target: a value from virNodeSuspendTarget
* @duration: currently unused, pass 0 * @duration: duration in seconds to suspend, or 0 for indefinite
* @flags: ditto * @flags: extra flags; not used yet, so callers should always pass 0
* *
* Attempt to suspend given domain. However, more * Attempt to have the guest enter the given @target power management
* states are supported than in virDomainSuspend. * 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. * guest agent to be available, e.g. QEMU.
* *
* Returns: 0 on success, * Returns: 0 on success,