1
0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-03-07 17:28:15 +00:00

Doc: Improve the document for nodesuspend

Explicitly lists the possible values for "--target" option;
Gets rid of the confused strings like "Suspend-to-RAM";
Emphasises the node *has to* be suspended in the time duration
specified by "--duration". And rewords the entire document a
bit according to the API's implementation and document.
This commit is contained in:
Osier Yang 2014-01-22 14:55:34 +08:00
parent 881a2cff0d
commit 39a0e32867

View File

@ -297,11 +297,14 @@ If I<cell> is specified, this will prints specified cell statistics only.
=item B<nodesuspend> [I<target>] [I<duration>] =item B<nodesuspend> [I<target>] [I<duration>]
Puts the node (host machine) into a system-wide sleep state such as Puts the node (host machine) into a system-wide sleep state and schedule
Suspend-to-RAM, Suspend-to-Disk or Hybrid-Suspend and sets up a the node's Real-Time-Clock interrupt to resume the node after the time
Real-Time-Clock interrupt to fire (to wake up the node) after a time delay duration specified by I<duration> is out.
specified by the 'duration' parameter. The duration time should be I<target> specifies the state to which the host will be suspended to, it
at least 60 seconds. can be "mem" (suspend to RAM), "disk" (suspend to disk), or "hybrid"
(suspend to both RAM and disk). I<duration> specifies the time duration
in seconds for which the host has to be suspended, it should be at least
60 seconds.
=item B<node-memory-tune> [I<shm-pages-to-scan>] [I<shm-sleep-millisecs>] =item B<node-memory-tune> [I<shm-pages-to-scan>] [I<shm-sleep-millisecs>]