virsh: Document --rdma-pin-all migrate option properly

https://bugzilla.redhat.com/show_bug.cgi?id=1368351

Signed-off-by: Jiri Denemark <jdenemar@redhat.com>

diff --git a/tools/virsh-domain.c b/tools/virsh-domain.c
index dedddeb96681b548903153c72a8337fa53eafa56..242f15ef9768e2d8dae108edf0fa90ba5d2ac1e8 100644 (file)
--- a/tools/virsh-domain.c
+++ b/tools/virsh-domain.c
@@ -10022,7 +10022,7 @@ static const vshCmdOptDef opts_migrate[] = {
     },
     {.name = "rdma-pin-all",
      .type = VSH_OT_BOOL,
-     .help = N_("support memory pinning during RDMA live migration")
+     .help = N_("pin all memory before starting RDMA live migration")
     },
     {.name = "abort-on-error",
      .type = VSH_OT_BOOL,

diff --git a/tools/virsh.pod b/tools/virsh.pod
index 74d531122b03a7ffd27c282211a58853a48ac1bf..894863848c1250c0a00275fca7b9402d289e3990 100644 (file)
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -1618,7 +1618,7 @@ to the I<uri> namespace is displayed instead of being modified.
 =item B<migrate> [I<--live>] [I<--offline>] [I<--direct>] [I<--p2p> [I<--tunnelled>]]
 [I<--persistent>] [I<--undefinesource>] [I<--suspend>] [I<--copy-storage-all>]
 [I<--copy-storage-inc>] [I<--change-protection>] [I<--unsafe>] [I<--verbose>]
-[I<--abort-on-error>] [I<--postcopy>] [I<--postcopy-after-precopy>]
+[I<--rdma-pin-all>] [I<--abort-on-error>] [I<--postcopy>] [I<--postcopy-after-precopy>]
 I<domain> I<desturi> [I<migrateuri>] [I<graphicsuri>] [I<listen-address>] [I<dname>]
 [I<--timeout> B<seconds> [I<--timeout-suspend> | I<--timeout-postcopy>]]
 [I<--xml> B<file>] [I<--migrate-disks> B<disk-list>] [I<--disks-port> B<port>]
@@ -1662,6 +1662,10 @@ guest CPU throttling rate can be set with I<auto-converge-initial>. If the
 initial throttling rate is not enough to ensure convergence, the rate is
 periodically increased by I<auto-converge-increment>.
 
+I<--rdma-pin-all> can be used with RDMA migration (i.e., when I<migrateuri>
+starts with rdma://) to tell the hypervisor to pin all domain's memory at once
+before migration starts rather then letting it pin memory pages as needed.
+
 B<Note>: Individual hypervisors usually do not support all possible types of
 migration. For example, QEMU does not support direct migration.