diff mbox series

[PULL,13/13] hmp/migration: Fix documents for "migrate" command

Message ID 20240502202316.29924-14-farosas@suse.de
State New
Headers show
Series [PULL,01/13] migration/ram.c: API Conversion qemu_mutex_lock(), and qemu_mutex_unlock() to WITH_QEMU_LOCK_GUARD macro | expand

Commit Message

Fabiano Rosas May 2, 2024, 8:23 p.m. UTC
From: Peter Xu <peterx@redhat.com>

Peter missed the Sphinx HMP document for the "resume/-r" flag in commit
7a4da28b26 ("qmp: hmp: add migrate "resume" option").  Add it.  Avoid
adding a Fixes to make life easier for the stable maintainer.

When at it, slightly cleanup the lines, move "detach/-d" to a separate
section rather than appending it at the end of the command description.

Cc: Dr. David Alan Gilbert <dave@treblig.org>
Cc: Fabiano Rosas <farosas@suse.de>
Cc: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Peter Xu <peterx@redhat.com>
Reviewed-by: Fabiano Rosas <farosas@suse.de>
Signed-off-by: Fabiano Rosas <farosas@suse.de>
---
 hmp-commands.hx | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

Comments

Markus Armbruster May 3, 2024, 6:59 a.m. UTC | #1
Fabiano Rosas <farosas@suse.de> writes:

> From: Peter Xu <peterx@redhat.com>
>
> Peter missed the Sphinx HMP document for the "resume/-r" flag in commit
> 7a4da28b26 ("qmp: hmp: add migrate "resume" option").  Add it.  Avoid
> adding a Fixes to make life easier for the stable maintainer.
>
> When at it, slightly cleanup the lines, move "detach/-d" to a separate
> section rather than appending it at the end of the command description.
>
> Cc: Dr. David Alan Gilbert <dave@treblig.org>
> Cc: Fabiano Rosas <farosas@suse.de>
> Cc: Markus Armbruster <armbru@redhat.com>
> Signed-off-by: Peter Xu <peterx@redhat.com>
> Reviewed-by: Fabiano Rosas <farosas@suse.de>
> Signed-off-by: Fabiano Rosas <farosas@suse.de>
> ---
>  hmp-commands.hx | 9 +++++++--
>  1 file changed, 7 insertions(+), 2 deletions(-)
>
> diff --git a/hmp-commands.hx b/hmp-commands.hx
> index ebca2cdced..484a8a1c3a 100644
> --- a/hmp-commands.hx
> +++ b/hmp-commands.hx
> @@ -918,8 +918,13 @@ ERST
>  
>  
>  SRST
> -``migrate [-d]`` *uri*
> -  Migrate to *uri* (using -d to not wait for completion).
> +``migrate [-d] [-r]`` *uri*
> +  Migrate the current VM to *uri*.
> +
> +  ``-d``
> +    Run this command asynchronously, so that the command doesn't wait for completion.
> +  ``-r``
> +    Resume a paused postcopy migration.
>  ERST
>  
>      {

I have questions on this one.
Fabiano Rosas May 3, 2024, 12:51 p.m. UTC | #2
Markus Armbruster <armbru@redhat.com> writes:

> Fabiano Rosas <farosas@suse.de> writes:
>
>> From: Peter Xu <peterx@redhat.com>
>>
>> Peter missed the Sphinx HMP document for the "resume/-r" flag in commit
>> 7a4da28b26 ("qmp: hmp: add migrate "resume" option").  Add it.  Avoid
>> adding a Fixes to make life easier for the stable maintainer.
>>
>> When at it, slightly cleanup the lines, move "detach/-d" to a separate
>> section rather than appending it at the end of the command description.
>>
>> Cc: Dr. David Alan Gilbert <dave@treblig.org>
>> Cc: Fabiano Rosas <farosas@suse.de>
>> Cc: Markus Armbruster <armbru@redhat.com>
>> Signed-off-by: Peter Xu <peterx@redhat.com>
>> Reviewed-by: Fabiano Rosas <farosas@suse.de>
>> Signed-off-by: Fabiano Rosas <farosas@suse.de>
>> ---
>>  hmp-commands.hx | 9 +++++++--
>>  1 file changed, 7 insertions(+), 2 deletions(-)
>>
>> diff --git a/hmp-commands.hx b/hmp-commands.hx
>> index ebca2cdced..484a8a1c3a 100644
>> --- a/hmp-commands.hx
>> +++ b/hmp-commands.hx
>> @@ -918,8 +918,13 @@ ERST
>>  
>>  
>>  SRST
>> -``migrate [-d]`` *uri*
>> -  Migrate to *uri* (using -d to not wait for completion).
>> +``migrate [-d] [-r]`` *uri*
>> +  Migrate the current VM to *uri*.
>> +
>> +  ``-d``
>> +    Run this command asynchronously, so that the command doesn't wait for completion.
>> +  ``-r``
>> +    Resume a paused postcopy migration.
>>  ERST
>>  
>>      {
>
> I have questions on this one.

Yep, I should have waited longer before queuing this one, my bad.
Richard Henderson May 3, 2024, 1:10 p.m. UTC | #3
On 5/3/24 05:51, Fabiano Rosas wrote:
> Markus Armbruster <armbru@redhat.com> writes:
> 
>> Fabiano Rosas <farosas@suse.de> writes:
>>
>>> From: Peter Xu <peterx@redhat.com>
>>>
>>> Peter missed the Sphinx HMP document for the "resume/-r" flag in commit
>>> 7a4da28b26 ("qmp: hmp: add migrate "resume" option").  Add it.  Avoid
>>> adding a Fixes to make life easier for the stable maintainer.
>>>
>>> When at it, slightly cleanup the lines, move "detach/-d" to a separate
>>> section rather than appending it at the end of the command description.
>>>
>>> Cc: Dr. David Alan Gilbert <dave@treblig.org>
>>> Cc: Fabiano Rosas <farosas@suse.de>
>>> Cc: Markus Armbruster <armbru@redhat.com>
>>> Signed-off-by: Peter Xu <peterx@redhat.com>
>>> Reviewed-by: Fabiano Rosas <farosas@suse.de>
>>> Signed-off-by: Fabiano Rosas <farosas@suse.de>
>>> ---
>>>   hmp-commands.hx | 9 +++++++--
>>>   1 file changed, 7 insertions(+), 2 deletions(-)
>>>
>>> diff --git a/hmp-commands.hx b/hmp-commands.hx
>>> index ebca2cdced..484a8a1c3a 100644
>>> --- a/hmp-commands.hx
>>> +++ b/hmp-commands.hx
>>> @@ -918,8 +918,13 @@ ERST
>>>   
>>>   
>>>   SRST
>>> -``migrate [-d]`` *uri*
>>> -  Migrate to *uri* (using -d to not wait for completion).
>>> +``migrate [-d] [-r]`` *uri*
>>> +  Migrate the current VM to *uri*.
>>> +
>>> +  ``-d``
>>> +    Run this command asynchronously, so that the command doesn't wait for completion.
>>> +  ``-r``
>>> +    Resume a paused postcopy migration.
>>>   ERST
>>>   
>>>       {
>>
>> I have questions on this one.
> 
> Yep, I should have waited longer before queuing this one, my bad.

Ok, I will not process this pull request.


r~
diff mbox series

Patch

diff --git a/hmp-commands.hx b/hmp-commands.hx
index ebca2cdced..484a8a1c3a 100644
--- a/hmp-commands.hx
+++ b/hmp-commands.hx
@@ -918,8 +918,13 @@  ERST
 
 
 SRST
-``migrate [-d]`` *uri*
-  Migrate to *uri* (using -d to not wait for completion).
+``migrate [-d] [-r]`` *uri*
+  Migrate the current VM to *uri*.
+
+  ``-d``
+    Run this command asynchronously, so that the command doesn't wait for completion.
+  ``-r``
+    Resume a paused postcopy migration.
 ERST
 
     {