Add -incoming help text
PATCH 1/1 Add -incoming help text
From: "Dr. David Alan Gilbert" <[email protected]>
The help/man text for
-incoming defer
didn't make it through the merge of the code that implemented it.
--- qemu-options.hx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
qemu-options.hx +5 -1
@@ -3238,7 +3238,9 @@ DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ "-incoming fd:fd\n" \ "-incoming exec:cmdline\n" \ " accept incoming migration on given file descriptor\n" \ - " or from given external command\n", + " or from given external command\n" \ + "-incoming defer\n" \ + " wait for the URI to be specified via migrate_incoming\n", QEMU_ARCH_ALL) STEXI @item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6]
@@ -3254,6 +3256,8 @@ Accept incoming migration from a given filedescriptor. @item -incoming exec:@var{cmdline} Accept incoming migration as an output from specified external command. +@item -incoming defer +Wait for the URI to be specified via migrate_incoming. ETEXI DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
Signature · 1 line
2.4.1
Quoted 29 lines · Dr. David Alan Gilbert (git)
From: "Dr. David Alan Gilbert" <[email protected]>
The help/man text for
-incoming defer
didn't make it through the merge of the code that implemented it.
Signed-off-by Dr. David Alan Gilbert <[email protected]>--- qemu-options.hx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)qemu-options.hx +3
-1@@ -3238,7 +3238,9 @@ DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ "-incoming fd:fd\n" \ "-incoming exec:cmdline\n" \ " accept incoming migration on given file descriptor\n" \ - " or from given external command\n", + " or from given external command\n" \ + "-incoming defer\n" \ + " wait for the URI to be specified via migrate_incoming\n", QEMU_ARCH_ALL) STEXI @item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6]
qemu-options.hx Accept incoming migration from a given filedescriptor. · line 3260
Quoted 5 lines
qemu-options.hx +2
-0@@ -3254,6 +3256,8 @@ Accept incoming migration from a given filedescriptor. @item -incoming exec:@var{cmdline} Accept incoming migration as an output from specified external command. +@item -incoming defer +Wait for the URI to be specified via migrate_incoming.
I wonder what's the reason of mentioning it twice with such a short and _identical_ text each time... Maybe it's a good idea to reword the second message a bit. Because actually it is not clear what does the whole thing mean, what qemu will do when starting? Will it accept other commands?
Thanks,
/mjt
Quoted 31 lines · Michael Tokarev
Quoted 30 lines · Dr. David Alan Gilbert (git)
From: "Dr. David Alan Gilbert" <[email protected]>
The help/man text for
-incoming defer
didn't make it through the merge of the code that implemented it.
Signed-off-by Dr. David Alan Gilbert <[email protected]>--- qemu-options.hx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)qemu-options.hx +3
-1@@ -3238,7 +3238,9 @@ DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ "-incoming fd:fd\n" \ "-incoming exec:cmdline\n" \ " accept incoming migration on given file descriptor\n" \ - " or from given external command\n", + " or from given external command\n" \ + "-incoming defer\n" \ + " wait for the URI to be specified via migrate_incoming\n", QEMU_ARCH_ALL) STEXI @item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6]@@ -3254,6 +3256,8 @@ Accept incoming migration from a given filedescriptor.
Quoted 7 lines
qemu-options.hx Accept incoming migration from a given filedescriptor. · line 3260
Quoted 4 lines
qemu-options.hx +2
-0@item -incoming exec:@var{cmdline} Accept incoming migration as an output from specified external command. +@item -incoming defer +Wait for the URI to be specified via migrate_incoming.I wonder what's the reason of mentioning it twice with such a short and _identical_ text each time...
Because that's the way our documentation works.
The first hunk patches the fourth argument of DEF(), which goes into -help.
The second hunk patches STEXI..ETEXI, which goes via qemu-options.texi into qemu.1 and qemu-doc.{dvi,info,html,pdf}.
Quoted 5 lines
Maybe
it's a good idea to reword the second message a bit. Because actually it is not clear what does the whole thing mean, what qemu will do when starting? Will it accept other commands?
You're right in that .texi allows more verbose explanations than -help.
David's text looks okay to me as is. Perhaps your questions inspire further improvements.
Quoted 55 lines · * Markus Armbruster ([email protected]) wrote:
Quoted 31 lines · Michael Tokarev
Quoted 30 lines · Dr. David Alan Gilbert (git)
From: "Dr. David Alan Gilbert" <[email protected]>
The help/man text for
-incoming defer
didn't make it through the merge of the code that implemented it.
Signed-off-by Dr. David Alan Gilbert <[email protected]>--- qemu-options.hx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)qemu-options.hx +3
-1@@ -3238,7 +3238,9 @@ DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ "-incoming fd:fd\n" \ "-incoming exec:cmdline\n" \ " accept incoming migration on given file descriptor\n" \ - " or from given external command\n", + " or from given external command\n" \ + "-incoming defer\n" \ + " wait for the URI to be specified via migrate_incoming\n", QEMU_ARCH_ALL) STEXI @item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6]@@ -3254,6 +3256,8 @@ Accept incoming migration from a given filedescriptor.Quoted 7 lines
qemu-options.hx Accept incoming migration from a given filedescriptor. · line 3260
Quoted 4 lines
qemu-options.hx +2
-0@item -incoming exec:@var{cmdline} Accept incoming migration as an output from specified external command. +@item -incoming defer +Wait for the URI to be specified via migrate_incoming.I wonder what's the reason of mentioning it twice with such a short and _identical_ text each time...
Because that's the way our documentation works.
The first hunk patches the fourth argument of
DEF(), which goes into -help.The second hunk patches STEXI..ETEXI, which goes via qemu-options.texi into qemu.1 and qemu-doc.{dvi,info,html,pdf}.
Quoted 5 lines
Maybe
it's a good idea to reword the second message a bit. Because actually it is not clear what does the whole thing mean, what qemu will do when starting? Will it accept other commands?
Quoted 4 lines
You're right in that .texi allows more verbose explanations than -help.
David's text looks okay to me as is. Perhaps your questions inspire further improvements.
How about changing the second part to.
+@item -incoming defer
+Wait for the URI to be specified via migrate_incoming. The monitor can +be used to change settings (such as migration parameters) prior to issuing +the migrate_incoming to allow the migration to begin.
Dave
--
Dr. David Alan Gilbert / [email protected] / Manchester, UK
Markus Armbruster
Reviewed-byQuoted 64 lines · Dr. David Alan Gilbert
Quoted 55 lines · * Markus Armbruster ([email protected]) wrote:
Quoted 31 lines · Michael Tokarev
Quoted 30 lines · Dr. David Alan Gilbert (git)
From: "Dr. David Alan Gilbert" <[email protected]>
The help/man text for
-incoming defer
didn't make it through the merge of the code that implemented it.
Signed-off-by Dr. David Alan Gilbert <[email protected]>--- qemu-options.hx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)qemu-options.hx +3
-1@@ -3238,7 +3238,9 @@ DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ "-incoming fd:fd\n" \ "-incoming exec:cmdline\n" \ " accept incoming migration on given file descriptor\n" \ - " or from given external command\n", + " or from given external command\n" \ + "-incoming defer\n" \ + " wait for the URI to be specified via migrate_incoming\n", QEMU_ARCH_ALL) STEXI @item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6]@@ -3254,6 +3256,8 @@ Accept incoming migration from a given filedescriptor.Quoted 7 lines
qemu-options.hx Accept incoming migration from a given filedescriptor. · line 3260
Quoted 4 lines
qemu-options.hx +2
-0@item -incoming exec:@var{cmdline} Accept incoming migration as an output from specified external command. +@item -incoming defer +Wait for the URI to be specified via migrate_incoming.I wonder what's the reason of mentioning it twice with such a short and _identical_ text each time...
Because that's the way our documentation works.
The first hunk patches the fourth argument of
DEF(), which goes into -help.The second hunk patches STEXI..ETEXI, which goes via qemu-options.texi into qemu.1 and qemu-doc.{dvi,info,html,pdf}.
Quoted 5 lines
Maybe
it's a good idea to reword the second message a bit. Because actually it is not clear what does the whole thing mean, what qemu will do when starting? Will it accept other commands?Quoted 4 lines
You're right in that .texi allows more verbose explanations than -help.
David's text looks okay to me as is. Perhaps your questions inspire further improvements.
How about changing the second part to.
+@item -incoming defer
Review
Quoted 3 lines
(quoted diff) +3
-0+Wait for the URI to be specified via migrate_incoming. The monitor can +be used to change settings (such as migration parameters) prior to issuing +the migrate_incoming to allow the migration to begin.
I like it.
Preferably with this improvement:
Michael Tokarev
AppliedQuoted 7 lines · Dr. David Alan Gilbert (git)
From: "Dr. David Alan Gilbert" <[email protected]>
The help/man text for
-incoming defer
didn't make it through the merge of the code that implemented it.
Applied to -trivial, with the more verbose text for the documentation.
Thank you very much!
/mjt