Skip to content

Commit db8cb7b

Browse files
xzpeterFabiano Rosas
authored andcommitted
hmp/migration: Fix "migrate" command's documentation
Peter missed the Sphinx HMP document for the "resume/-r" flag in commit 7a4da28 ("qmp: hmp: add migrate "resume" option"). Add it. When at it, slightly cleanup the lines around: - Move "detach/-d" to a separate section rather than appending it at the end of the command description. Add a hint for how to query the migration results in detached mode. - Add "postcopy" keyword to "resume/-r" help messages, as it only applies to postcopy. Cc: Dr. David Alan Gilbert <[email protected]> Cc: Fabiano Rosas <[email protected]> Fixes: 7a4da28 ("qmp: hmp: add migrate "resume" option") Reported-by: Markus Armbruster <[email protected]> Reviewed-by: Markus Armbruster <[email protected]> Signed-off-by: Peter Xu <[email protected]> Signed-off-by: Fabiano Rosas <[email protected]>
1 parent c55deb8 commit db8cb7b

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

hmp-commands.hx

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -912,14 +912,20 @@ ERST
912912
.args_type = "detach:-d,resume:-r,uri:s",
913913
.params = "[-d] [-r] uri",
914914
.help = "migrate to URI (using -d to not wait for completion)"
915-
"\n\t\t\t -r to resume a paused migration",
915+
"\n\t\t\t -r to resume a paused postcopy migration",
916916
.cmd = hmp_migrate,
917917
},
918918

919919

920920
SRST
921-
``migrate [-d]`` *uri*
922-
Migrate to *uri* (using -d to not wait for completion).
921+
``migrate [-d] [-r]`` *uri*
922+
Migrate the VM to *uri*.
923+
924+
``-d``
925+
Start the migration process, but do not wait for its completion. To
926+
query an ongoing migration process, use "info migrate".
927+
``-r``
928+
Resume a paused postcopy migration.
923929
ERST
924930

925931
{

0 commit comments

Comments
 (0)