From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:46367) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VYSW5-0003zU-Me for qemu-devel@nongnu.org; Mon, 21 Oct 2013 23:20:29 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VYSVv-0002n4-Fj for qemu-devel@nongnu.org; Mon, 21 Oct 2013 23:20:21 -0400 Received: from e28smtp03.in.ibm.com ([122.248.162.3]:51304) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VYSVu-0002ls-SJ for qemu-devel@nongnu.org; Mon, 21 Oct 2013 23:20:11 -0400 Received: from /spool/local by e28smtp03.in.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Tue, 22 Oct 2013 08:50:03 +0530 Received: from d28relay01.in.ibm.com (d28relay01.in.ibm.com [9.184.220.58]) by d28dlp01.in.ibm.com (Postfix) with ESMTP id 74DE6E004A for ; Tue, 22 Oct 2013 08:51:31 +0530 (IST) Received: from d28av02.in.ibm.com (d28av02.in.ibm.com [9.184.220.64]) by d28relay01.in.ibm.com (8.13.8/8.13.8/NCO v10.0) with ESMTP id r9M3Mosn32637096 for ; Tue, 22 Oct 2013 08:52:51 +0530 Received: from d28av02.in.ibm.com (localhost [127.0.0.1]) by d28av02.in.ibm.com (8.14.4/8.14.4/NCO v10.0 AVout) with ESMTP id r9M3JwWV010192 for ; Tue, 22 Oct 2013 08:49:59 +0530 Message-ID: <5265EEDC.3080900@linux.vnet.ibm.com> Date: Tue, 22 Oct 2013 11:19:56 +0800 From: Wenchao Xia MIME-Version: 1.0 References: <1382321765-29052-1-git-send-email-xiawenc@linux.vnet.ibm.com> <1382321765-29052-7-git-send-email-xiawenc@linux.vnet.ibm.com> <526595ED.5090506@redhat.com> In-Reply-To: <526595ED.5090506@redhat.com> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 8bit Subject: Re: [Qemu-devel] [PATCH 6/6] qapi: add doc for QEvent List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Eric Blake , qemu-devel@nongnu.org Cc: kwolf@redhat.com, pbonzini@redhat.com, armbru@redhat.com, stefanha@redhat.com, lcapitulino@redhat.com 于 2013/10/22 5:00, Eric Blake 写道: > On 10/21/2013 03:16 AM, Wenchao Xia wrote: >> Signed-off-by: Wenchao Xia >> --- >> qapi-schema.json | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ >> 1 files changed, 56 insertions(+), 0 deletions(-) > Incomplete. Now that you are actually using the enum (see the spot I > pointed out in 5/6), you ALSO need to change: > > -{ 'type': 'EventInfo', 'data': {'name': 'str'} } > +{ 'type': 'EventInfo', 'data': {'name': 'QEvent'} } > > and make use of the enum in the QAPI documentation. > Will add this part, thanks for tipping it. >> # >> +# @SHUTDOWN: system shutdown >> +# >> +# @RESET: system resets > s/resets/has reset/ > >> +# >> +# @POWERDOWN: system power down, if it is suppoted > s/suppoted/supported/ > > Events aren't issued if they aren't supported, so that phrase is pointless. Ok, I will skip that phrase. The point here is that, many people are confused about shutdown and powerdown, and it seems POWERDOWN item is not present in doc/qmp/qapi-events.txt? I want to add doc tips the difference: How about: It will set the system power control unit to notify guest, such as ACPI chips.(This is where I am not sure, the qemu online doc says, shutdown is gracefully....). >> +# >> +# @STOP: stops the emulation >> +# > Your use of present tense makes it sounds like this is a causal command > ("issuing STOP will stop the emulation"), but you really want it to > sound like a notification of an effect ("STOP is issued after emulation > is stopped). That is: > > s/stops the emulation/emulation stopped/ Do you mean all tense in the doc should use past tense? I hesitated before about tense usage, it seems not all event is emitted after it happens, for example, powerdown emitted before it call notifier to set the states. Take another think, I think I may use past tense through the doc, but with more carefully meaning, such as: the system has enter powerdown state. If you agree with the tense, I'd like sent the reformed doc in the following, before respin. >> +# @RESUME: resumes the emulation, typically after system stop > Again, tense matters; I suggest: > > @RESUME: emulation resumed > >> +# >> +# @VNC_CONNECTED: a vnc client has connected to system >> +# >> +# @VNC_INITIALIZED: system has initialized for a vnc client >> +# >> +# @VNC_DISCONNECTED: a vnc client has disconnected from system >> +# >> +# @BLOCK_IO_ERROR: block layer meets I/O error > s/meets/encountered an/ > >> +# >> +# @RTC_CHANGE: rtc changes > s/changes/changed/ > >> +# >> +# @WATCHDOG: watch dog performs a action > I suggest: > > @WATCHDOG: watchdog expired OK. >> +# >> +# @SPICE_CONNECTED: a spice client has connected to system >> +# >> +# @SPICE_INITIALIZED: system has initialized for a spice client >> +# >> +# @SPICE_DISCONNECTED: a spice client has disconnected from system >> +# >> +# @BLOCK_JOB_COMPLETED: a block job has been completed >> +# >> +# @BLOCK_JOB_CANCELLED: a block job has been cancelled >> +# >> +# @BLOCK_JOB_ERROR: a block job meets error > s/meets/encountered an/ > >> +# >> +# @BLOCK_JOB_READY: a block job is ready >> +# >> +# @DEVICE_DELETED: a device has been deleted >> +# >> +# @DEVICE_TRAY_MOVED: a device tray's status has changed >> +# >> +# @NIC_RX_FILTER_CHANGED: the filter for receiving on a nic has been changed >> +# >> +# @SUSPEND: system suspends, typically request comes from guest > No need to say the typical cause for an event here; I'd much rather see > us give that extra detail in the place where we further describe each > event (more on that later). I suggest: > > @SUSPEND: system has suspended to memory (S3 power state) > >> +# >> +# @SUSPEND_DISK: system suspends to disk, typically request comes from guest > I suggest: > > @SUSPEND_DISK: system has suspended to disk (S4 power state) > >> +# >> +# @WAKEUP: system wakes up from suspend > s/wakes/woke/ > >> +# >> +# @BALLOON_CHANGE: system resource balloon status changes > s/changes/changed/ > >> +# >> +# @SPICE_MIGRATE_COMPLETED: spice migration has been completed >> +# >> +# @GUEST_PANICKED: guest has panicked >> +# >> +# @BLOCK_IMAGE_CORRUPTED: block image has been corrupted >> +# >> # Since: 1.8 >> ## >> { 'enum': 'QEvent', >> > Good start, but this series needs more. Ultimately, I'd like to get rid > of docs/qmp/qmp-events.txt, and inline that content into > qapi-schema.json. We already documented how to do it: > > https://lists.gnu.org/archive/html/qemu-devel/2013-09/msg02164.html I'll take a look to find a good way inline those content.