Add more documents to mention about "query-dump" and DUMP_COMPLETED events.
Signed-off-by: Peter Xu <pet...@redhat.com> --- qapi-schema.json | 7 +++++-- qmp-commands.hx | 4 +++- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/qapi-schema.json b/qapi-schema.json index 577c381..ce4acb2 100644 --- a/qapi-schema.json +++ b/qapi-schema.json @@ -2115,8 +2115,11 @@ # 2. fd: the protocol starts with "fd:", and the following string # is the fd's name. # -# @detach: #optional if true, QMP will return immediately rather than -# waiting dump to be finished (since 2.6). +# @detach: #optional if true, QMP will return immediately rather +# than waiting dump to be finished. If this is specified, +# user could later use "query-dump" to check latest dump +# status. When dump finishes, one event DUMP_COMPLETED will +# be sent to the user to notify the completion (since 2.6). # # @begin: #optional if specified, the starting physical address. # diff --git a/qmp-commands.hx b/qmp-commands.hx index ac6d2da..cd097d4 100644 --- a/qmp-commands.hx +++ b/qmp-commands.hx @@ -858,7 +858,9 @@ Arguments: - "protocol": destination file(started with "file:") or destination file descriptor (started with "fd:") (json-string) - "detach": if specificed, command will return immediately, without waiting - for dump to be finished (json-bool) + for dump to be finished. After command return, user + could query for latest dump status using "query-dump". When dump + finishes, an event DUMP_COMPLETED will be sent (json-bool) - "begin": the starting physical address. It's optional, and should be specified with length together (json-int) - "length": the memory size, in bytes. It's optional, and should be specified -- 2.4.3