[libvirt] [PATCH] virsh: Clarify documentation for virsh dompmsuspend command

[Peter Krempa]

Clarify the docs to make more clear what this command does and that it
requires a guest agent running in the guest.
---
 tools/virsh.c   |    7 +++++--
 tools/virsh.pod |   10 +++++++++-
 2 files changed, 14 insertions(+), 3 deletions(-)

diff --git a/tools/virsh.c b/tools/virsh.c
index 265857d..55cbe2b 100644
--- a/tools/virsh.c
+++ b/tools/virsh.c
@@ -2761,8 +2761,11 @@ cmdSuspend(vshControl *ctl, const vshCmd *cmd)
  * "dompmsuspend" command
  */
 static const vshCmdInfo info_dom_pm_suspend[] = {
-    {"help", N_("suspend a domain for a given time duration")},
-    {"desc", N_("Suspend a running domain for a given time duration.")},
+    {"help", N_("suspend a domain gracefully using power management "
+                "functions")},
+    {"desc", N_("Suspends a running domain using guest OS's power management. "
+                "(Note: This requires a guest agent configured and running in "
+                "the guest OS).")},
     {NULL, NULL}
 };

diff --git a/tools/virsh.pod b/tools/virsh.pod
index f83a29d..6250b89 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -1487,7 +1487,7 @@ Moves a domain out of the suspended state.  This will allow a previously
 suspended domain to now be eligible for scheduling by the underlying
 hypervisor.

-=item B<dompmsuspend> I<domain-id> I<target>
+=item B<dompmsuspend> I<domain-id> I<target> [I<--duration>]

 Suspend a running domain into one of these states (possible I<target>
 values):
@@ -1495,6 +1495,14 @@ values):
     disk equivallent of S4 ACPI state
     hybrid RAM is saved to disk but not powered off

+The I<--duration> argument specifies number of seconds before the domain is
+woken up after it was suspended (see also B<dompmwakeup>). Default is 0 for
+unlimited suspend time. (This feature isn't currently supported by any
+hypervisor driver and 0 should be used.).
+
+Note that this command requires a guest agent configured and running in the
+domain's guest OS.
+
 =item B<dompmwakeup> I<domain-id>

 Wakeup a domain suspended by dompmsuspend command. Injects a wakeup
-- 
1.7.8.6