[libvirt] [PATCH 1/3] virsh: clarify snapshot vs. save

[Eric Blake]

* tools/virsh.c (info_snapshot_create, info_save): Clarify
description.
* tools/virsh.pod (save): Likewise.
---
 tools/virsh.c   |    6 +++---
 tools/virsh.pod |    8 +++++++-
 2 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/tools/virsh.c b/tools/virsh.c
index 1c0b1dc..6b5f3d9 100644
--- a/tools/virsh.c
+++ b/tools/virsh.c
@@ -1469,7 +1469,7 @@ cmdStart(vshControl *ctl, const vshCmd *cmd)
  */
 static const vshCmdInfo info_save[] = {
     {"help", N_("save a domain state to a file")},
-    {"desc", N_("Save a running domain.")},
+    {"desc", N_("Save the RAM state of a running domain.")},
     {NULL, NULL}
 };

@@ -10947,8 +10947,8 @@ cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
  * "snapshot-create" command
  */
 static const vshCmdInfo info_snapshot_create[] = {
-    {"help", N_("Create a snapshot")},
-    {"desc", N_("Snapshot create")},
+    {"help", N_("Create a snapshot from XML")},
+    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
     {NULL, NULL}
 };

diff --git a/tools/virsh.pod b/tools/virsh.pod
index c6879cb..33f72ed 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -594,7 +594,8 @@ the state file was created.

 =item B<save> I<domain-id> I<state-file>

-Saves a running domain to a state file so that it can be restored
+Saves a running domain (RAM, but not disk state) to a state file so that
+it can be restored
 later.  Once saved, the domain will no longer be running on the
 system, thus the memory allocated for the domain will be free for
 other domains to use.  B<virsh restore> restores from this state file.
@@ -603,6 +604,11 @@ This is roughly equivalent to doing a hibernate on a running computer,
 with all the same limitations.  Open network connections may be
 severed upon restore, as TCP timeouts may have expired.

+Domain saved state files assume that disk images will be unchanged
+between the creation and restore point.  For a more complete system
+restore point, where the disk state is saved alongside the memory
+state, see the B<snapshot> family of commands.
+
 =item B<schedinfo> optional I<--set> B<parameter=value> I<domain-id> I<--config>
 I<--live> I<--current>

-- 
1.7.1