From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:35725) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1a3MjI-0001sB-2T for qemu-devel@nongnu.org; Mon, 30 Nov 2015 06:34:48 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1a3MjD-0005Ga-Va for qemu-devel@nongnu.org; Mon, 30 Nov 2015 06:34:48 -0500 Received: from mx1.redhat.com ([209.132.183.28]:50936) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1a3MjD-0005GW-RX for qemu-devel@nongnu.org; Mon, 30 Nov 2015 06:34:43 -0500 Received: from int-mx11.intmail.prod.int.phx2.redhat.com (int-mx11.intmail.prod.int.phx2.redhat.com [10.5.11.24]) by mx1.redhat.com (Postfix) with ESMTPS id 9508BC0D223A for ; Mon, 30 Nov 2015 11:34:43 +0000 (UTC) From: Peter Xu Date: Mon, 30 Nov 2015 19:32:20 +0800 Message-Id: <1448883140-20249-13-git-send-email-peterx@redhat.com> In-Reply-To: <1448883140-20249-1-git-send-email-peterx@redhat.com> References: <1448883140-20249-1-git-send-email-peterx@redhat.com> Subject: [Qemu-devel] [PATCH v3 12/12] Dump: enhance the documentations. List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: drjones@redhat.com, lersek@redhat.com, armbru@redhat.com, peterx@redhat.com, lcapitulino@redhat.com, famz@redhat.com, pbonzini@redhat.com Add more documents to mention about "query-dump" and DUMP_COMPLETED events. Signed-off-by: Peter Xu --- 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