From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:52479) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1a3cRe-0006vl-EG for qemu-devel@nongnu.org; Mon, 30 Nov 2015 23:21:39 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1a3cRZ-0001eP-JI for qemu-devel@nongnu.org; Mon, 30 Nov 2015 23:21:38 -0500 Received: from mx1.redhat.com ([209.132.183.28]:50943) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1a3cRZ-0001dj-DP for qemu-devel@nongnu.org; Mon, 30 Nov 2015 23:21:33 -0500 Received: from int-mx14.intmail.prod.int.phx2.redhat.com (int-mx14.intmail.prod.int.phx2.redhat.com [10.5.11.27]) by mx1.redhat.com (Postfix) with ESMTPS id 676F79D1D4 for ; Tue, 1 Dec 2015 04:21:32 +0000 (UTC) Date: Tue, 1 Dec 2015 12:21:13 +0800 From: Peter Xu Message-ID: <20151201042111.GJ21032@pxdev.xzpeter.org> References: <1448883140-20249-1-git-send-email-peterx@redhat.com> <1448883140-20249-13-git-send-email-peterx@redhat.com> <565CCC2D.9050503@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline In-Reply-To: <565CCC2D.9050503@redhat.com> Subject: Re: [Qemu-devel] [PATCH v3 12/12] Dump: enhance the documentations. List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Eric Blake Cc: drjones@redhat.com, armbru@redhat.com, qemu-devel@nongnu.org, famz@redhat.com, pbonzini@redhat.com, lcapitulino@redhat.com, lersek@redhat.com On Mon, Nov 30, 2015 at 03:22:37PM -0700, Eric Blake wrote: > On 11/30/2015 04:32 AM, Peter Xu wrote: > > 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(-) > > Why not squash this in to the patch that introduces the options? No > need to have churn within the series by tweaking the documentation more > than once. Ok. Will do that. > > > > > 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 > > s/one event DUMP_COMPLETED/a DUMP_COMPLETED event/ > > > +# be sent to the user to notify the completion (since 2.6). > > s/to the user to notify the completion// > > > # > > # @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) > > Awkward. How about: > > - "detach": if specified, the command will return immediately rather > than waiting for the dump completion. The user can track progress with > "query-dump", and a DUMP_COMPLETED event will occur at the end. (json-bool) Sorry for the awkward English... Will take your version. Thanks. :) Peter > > -- > Eric Blake eblake redhat com +1-919-301-3266 > Libvirt virtualization library http://libvirt.org >