Re: [libvirt] [PATCH 2/3] Doc: Improve the document for nodesuspend

On 01/22/2014 07:55 AM, Osier Yang wrote: > 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. > --- > tools/virsh.pod | 13 ++++++++----- > 1 file changed, 8 insertions(+), 5 deletions(-) > > diff --git a/tools/virsh.pod b/tools/virsh.pod > index 8839e3c..35a7292 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"(suspended to RAM), "disk"(suspended to disk), or "hybrid" > +(suspended to both RAM and disk). I<duration> specifies the time duration This would look better with spaces in front of the parentheses. I think 'suspend' instead of 'suspended' would look better inside the parentheses too.