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

[Guannan Ren <gren@xxxxxxxxxx>]

libvirt asks the duration time is above 60 seconds in code

src/util/virnodesuspend.c:
    define MIN_TIME_REQ_FOR_SUSPEND 60 /* in seconds */

    if (alarmTime <= MIN_TIME_REQ_FOR_SUSPEND) {
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("Suspend duration is too short"));
        return -1;
    }

    Update the information in virsh help and manpage.
---
 tools/virsh.c   |    2 +-
 tools/virsh.pod |    3 ++-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/tools/virsh.c b/tools/virsh.c
index b9e159b..21ebca2 100644
--- a/tools/virsh.c
+++ b/tools/virsh.c
@@ -6986,7 +6986,7 @@ 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")},
     {"flags", VSH_OT_INT, VSH_OFLAG_NONE, N_("Suspend flags, 0 for default")},
     {NULL, 0, 0, NULL}
 };
diff --git a/tools/virsh.pod b/tools/virsh.pod
index 4bddf15..690707f 100644
--- a/tools/virsh.pod
+++ 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 above
+60 seconds.
 
 =item B<capabilities>
 
-- 
1.7.7.5

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list