From cf46dfbc991f852959352307dd613df64a6fab73 Mon Sep 17 00:00:00 2001 Message-Id: From: Osier Yang Date: Wed, 22 Jan 2014 18:11:58 +0800 Subject: [PATCH] Doc: Improve the document for nodesuspend https://bugzilla.redhat.com/show_bug.cgi?id=1045089 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. (cherry picked from commit 39a0e328674c2252cedc034091b459e0f6779c16) Signed-off-by: Jiri Denemark --- tools/virsh.pod | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/tools/virsh.pod b/tools/virsh.pod index 74ea0bc..6b47d59 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -296,11 +296,14 @@ If I is specified, this will prints specified cell statistics only. =item B [I] [I] -Puts the node (host machine) into a system-wide sleep state such as -Suspend-to-RAM, Suspend-to-Disk or Hybrid-Suspend and sets up a -Real-Time-Clock interrupt to fire (to wake up the node) after a time delay -specified by the 'duration' parameter. The duration time should be -at least 60 seconds. +Puts the node (host machine) into a system-wide sleep state and schedule +the node's Real-Time-Clock interrupt to resume the node after the time +duration specified by I is out. +I specifies the state to which the host will be suspended to, it +can be "mem" (suspend to RAM), "disk" (suspend to disk), or "hybrid" +(suspend to both RAM and disk). I specifies the time duration +in seconds for which the host has to be suspended, it should be at least +60 seconds. =item B [I] [I] -- 1.8.5.3