From: Osier Yang <jyang@redhat.com>
Date: Wed, 22 Jan 2014 06:55:34 +0000 (+0800)
Subject: Doc: Improve the document for nodesuspend
X-Git-Tag: v1.2.2-rc1~241
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=39a0e328674c2252cedc034091b459e0f6779c16;p=thirdparty%2Flibvirt.git

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.
---

diff --git a/tools/virsh.pod b/tools/virsh.pod
index 8839e3cc87..abed66dfda 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -297,11 +297,14 @@ If I<cell> is specified, this will prints specified cell statistics only.
 
 =item B<nodesuspend> [I<target>] [I<duration>]
 
-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<duration> is out.
+I<target> 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<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>]