[libvirt] [PATCH] virsh: Document --rdma-pin-all migrate option in man page

[Jiri Denemark]

On Tue, Nov 22, 2016 at 19:47:21 +0100, Martin Kletzander wrote:
> On Tue, Nov 22, 2016 at 07:29:00PM +0100, Jiri Denemark wrote:
> > https://bugzilla.redhat.com/show_bug.cgi?id=1368351
> > 
> > Signed-off-by: Jiri Denemark <jdenemar at redhat.com>
> > ---
> > tools/virsh.pod | 6 +++++-
> > 1 file changed, 5 insertions(+), 1 deletion(-)
> > 
> > diff --git a/tools/virsh.pod b/tools/virsh.pod
> > index 74d531122..894863848 100644
> > --- 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.
> > 
> 
> You should also fix the help string when modifying this because "support
> memory pinning" doesn't seem like it means what's meantioned in this
> paragraph (which feel way more precise).
> 
> ACK with that adjusted.

Is "pin all memory before starting RDMA live migration" compatible with
what you had in mind? :-)

Jirka