[libvirt] [PATCH] doc: update the minimum value for nodesuspend time duration

[Eric Blake]

On 07/19/2012 03:05 AM, Guannan Ren wrote:
> libvirt asks the duration time is above 60 seconds in code
> 
> src/util/virnodesuspend.c:
>     define MIN_TIME_REQ_FOR_SUSPEND 60 /* in seconds */
> 
> We should update the information in virsh help and manpage.
> ---
>  tools/virsh.c   |    3 ++-
>  tools/virsh.pod |    3 ++-
>  2 files changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/tools/virsh.c b/tools/virsh.c
> index b9e159b..95b2689 100644
> --- a/tools/virsh.c
> +++ b/tools/virsh.c
> @@ -6986,7 +6986,8 @@ static const vshCmdInfo info_nodesuspend[] = {
>  static const vshCmdOptDef opts_node_suspend[] = {
>      {"target", VSH_OT_DATA, VSH_OFLAG_REQ, N_("mem(Suspend-to-RAM), "
>                                                 "disk(Suspend-to-Disk), hybrid(Hybrid-Suspend)")},
> -    {"duration", VSH_OT_INT, VSH_OFLAG_REQ, N_("Suspend duration in seconds")},
> +    {"duration", VSH_OT_INT, VSH_OFLAG_REQ, N_("Suspend duration in seconds, "
> +                                               "above 60 seconds at least")},

I'd write this:

    {"duration", VSH_OT_INT, VSH_OFLAG_REQ,
     N_("Suspend duration in seconds, at least 60")},

> +++ b/tools/virsh.pod
> @@ -290,7 +290,8 @@ If I<cell> is specified, this will prints specified cell statistics only.
>  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.
> +specified by the 'duration' parameter. The duration time should be given
> +above 60 seconds.

It would read better as:

The duration time should be at least 60 seconds.

-- 
Eric Blake   eblake at redhat.com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org



-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 620 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20120719/f87a4ab9/attachment-0001.sig>