qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
* [Qemu-devel] [PULL for-2.1 0/5] QMP queue
@ 2014-07-24 14:17 Luiz Capitulino
  2014-07-24 14:17 ` [Qemu-devel] [PULL 1/5] docs: grammar fixes to qmp-events Luiz Capitulino
                   ` (5 more replies)
  0 siblings, 6 replies; 7+ messages in thread
From: Luiz Capitulino @ 2014-07-24 14:17 UTC (permalink / raw)
  To: peter.maydell; +Cc: qemu-devel, anthony

Doc fixes, zero regression risk for code.

The following changes since commit a537d373b9f330853006ceb18d5891541b9e4030:

  Merge remote-tracking branch 'remotes/kraxel/tags/pull-usb-20140723-1' into staging (2014-07-24 12:49:54 +0100)

are available in the git repository at:


  git://repo.or.cz/qemu/qmp-unstable.git queue/qmp

for you to fetch changes up to 032baddea36330384b3654fcbfafa74cc815471c:

  docs: document missing VSERPORT_CHANGE event (2014-07-24 10:00:33 -0400)

----------------------------------------------------------------
Eric Blake (5):
      docs: grammar fixes to qmp-events
      docs: split SPICE_* event docs
      docs: document missing SPICE_MIGRATE_COMPLETED event
      docs: document missing POWERDOWN event
      docs: document missing VSERPORT_CHANGE event

 docs/qmp/qmp-events.txt | 80 +++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 74 insertions(+), 6 deletions(-)

^ permalink raw reply	[flat|nested] 7+ messages in thread

* [Qemu-devel] [PULL 1/5] docs: grammar fixes to qmp-events
  2014-07-24 14:17 [Qemu-devel] [PULL for-2.1 0/5] QMP queue Luiz Capitulino
@ 2014-07-24 14:17 ` Luiz Capitulino
  2014-07-24 14:17 ` [Qemu-devel] [PULL 2/5] docs: split SPICE_* event docs Luiz Capitulino
                   ` (4 subsequent siblings)
  5 siblings, 0 replies; 7+ messages in thread
From: Luiz Capitulino @ 2014-07-24 14:17 UTC (permalink / raw)
  To: peter.maydell; +Cc: qemu-devel, anthony

From: Eric Blake <eblake@redhat.com>

When converting to qmp events, commits 7cfadb6b and a6330785
fixed some grammar as part of moving text between files.  But
since dfab4892 later restored this file to the state prior to
qmp events, we have to do it again.

* docs/qmp/qmp-events.txt (RESET, SPICE_INITIALIZED): Tweak.

Signed-off-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Wenchao Xia <wenchaoqemu@gmail.com>
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
---
 docs/qmp/qmp-events.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/qmp/qmp-events.txt b/docs/qmp/qmp-events.txt
index 4a6c2a2..524eadf 100644
--- a/docs/qmp/qmp-events.txt
+++ b/docs/qmp/qmp-events.txt
@@ -285,7 +285,7 @@ Example:
 RESET
 -----
 
-Emitted when the Virtual Machine is reseted.
+Emitted when the Virtual Machine is reset.
 
 Data: None.
 
@@ -366,7 +366,7 @@ SPICE_INITIALIZED
 -----------------
 
 Emitted after initial handshake and authentication takes place (if any)
-and the SPICE channel is up'n'running
+and the SPICE channel is up and running
 
 Data:
 
-- 
1.9.3

^ permalink raw reply related	[flat|nested] 7+ messages in thread

* [Qemu-devel] [PULL 2/5] docs: split SPICE_* event docs
  2014-07-24 14:17 [Qemu-devel] [PULL for-2.1 0/5] QMP queue Luiz Capitulino
  2014-07-24 14:17 ` [Qemu-devel] [PULL 1/5] docs: grammar fixes to qmp-events Luiz Capitulino
@ 2014-07-24 14:17 ` Luiz Capitulino
  2014-07-24 14:17 ` [Qemu-devel] [PULL 3/5] docs: document missing SPICE_MIGRATE_COMPLETED event Luiz Capitulino
                   ` (3 subsequent siblings)
  5 siblings, 0 replies; 7+ messages in thread
From: Luiz Capitulino @ 2014-07-24 14:17 UTC (permalink / raw)
  To: peter.maydell; +Cc: qemu-devel, anthony

From: Eric Blake <eblake@redhat.com>

For consistency with the rest of this file, every event should be
listed in isolation.  Compare how commit 7cfadb6b split
SPICE_CONNECTED and SPICE_DISCONNECTED into separate qmp events.

* docs/qmp/qmp-events.txt (SPICE_CONNECTED, SPICE_DISCONNECTED):
Split.

Signed-off-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Wenchao Xia <wenchaoqemu@gmail.com>
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
---
 docs/qmp/qmp-events.txt | 31 ++++++++++++++++++++++++++++---
 1 file changed, 28 insertions(+), 3 deletions(-)

diff --git a/docs/qmp/qmp-events.txt b/docs/qmp/qmp-events.txt
index 524eadf..9b7ee7c 100644
--- a/docs/qmp/qmp-events.txt
+++ b/docs/qmp/qmp-events.txt
@@ -337,10 +337,10 @@ Example:
 Note: If the command-line option "-no-shutdown" has been specified, a STOP
 event will eventually follow the SHUTDOWN event.
 
-SPICE_CONNECTED, SPICE_DISCONNECTED
------------------------------------
+SPICE_CONNECTED
+---------------
 
-Emitted when a SPICE client connects or disconnects.
+Emitted when a SPICE client connects.
 
 Data:
 
@@ -362,6 +362,31 @@ Example:
     "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
 }}
 
+SPICE_DISCONNECTED
+------------------
+
+Emitted when a SPICE client disconnects.
+
+Data:
+
+- "server": Server information (json-object)
+  - "host": IP address (json-string)
+  - "port": port number (json-string)
+  - "family": address family (json-string, "ipv4" or "ipv6")
+- "client": Client information (json-object)
+  - "host": IP address (json-string)
+  - "port": port number (json-string)
+  - "family": address family (json-string, "ipv4" or "ipv6")
+
+Example:
+
+{ "timestamp": {"seconds": 1290688046, "microseconds": 388707},
+  "event": "SPICE_DISCONNECTED",
+  "data": {
+    "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"},
+    "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
+}}
+
 SPICE_INITIALIZED
 -----------------
 
-- 
1.9.3

^ permalink raw reply related	[flat|nested] 7+ messages in thread

* [Qemu-devel] [PULL 3/5] docs: document missing SPICE_MIGRATE_COMPLETED event
  2014-07-24 14:17 [Qemu-devel] [PULL for-2.1 0/5] QMP queue Luiz Capitulino
  2014-07-24 14:17 ` [Qemu-devel] [PULL 1/5] docs: grammar fixes to qmp-events Luiz Capitulino
  2014-07-24 14:17 ` [Qemu-devel] [PULL 2/5] docs: split SPICE_* event docs Luiz Capitulino
@ 2014-07-24 14:17 ` Luiz Capitulino
  2014-07-24 14:17 ` [Qemu-devel] [PULL 4/5] docs: document missing POWERDOWN event Luiz Capitulino
                   ` (2 subsequent siblings)
  5 siblings, 0 replies; 7+ messages in thread
From: Luiz Capitulino @ 2014-07-24 14:17 UTC (permalink / raw)
  To: peter.maydell; +Cc: qemu-devel, anthony

From: Eric Blake <eblake@redhat.com>

The SPICE_MIGRATE_COMPLETED event was first documented in
7cfadb6b.  But since dfab4892 later restored this file to the
state prior to qmp events, and we never documented it in the
past, anyone using this file instead of qapi will miss out on
this event.

* docs/qmp/qmp-events.txt (SPICE_MIGRATE_COMPLETED): Add.

Signed-off-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Wenchao Xia <wenchaoqemu@gmail.com>
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
---
 docs/qmp/qmp-events.txt | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/qmp/qmp-events.txt b/docs/qmp/qmp-events.txt
index 9b7ee7c..22d552f 100644
--- a/docs/qmp/qmp-events.txt
+++ b/docs/qmp/qmp-events.txt
@@ -424,6 +424,19 @@ Example:
                       "channel-id": 0, "tls": true}
 }}
 
+SPICE_MIGRATE_COMPLETED
+-----------------------
+
+Emitted when SPICE migration has completed
+
+Data: None.
+
+Example:
+
+{ "timestamp": {"seconds": 1290688046, "microseconds": 417172},
+  "event": "SPICE_MIGRATE_COMPLETED" }
+
+
 STOP
 ----
 
-- 
1.9.3

^ permalink raw reply related	[flat|nested] 7+ messages in thread

* [Qemu-devel] [PULL 4/5] docs: document missing POWERDOWN event
  2014-07-24 14:17 [Qemu-devel] [PULL for-2.1 0/5] QMP queue Luiz Capitulino
                   ` (2 preceding siblings ...)
  2014-07-24 14:17 ` [Qemu-devel] [PULL 3/5] docs: document missing SPICE_MIGRATE_COMPLETED event Luiz Capitulino
@ 2014-07-24 14:17 ` Luiz Capitulino
  2014-07-24 14:17 ` [Qemu-devel] [PULL 5/5] docs: document missing VSERPORT_CHANGE event Luiz Capitulino
  2014-07-24 16:16 ` [Qemu-devel] [PULL for-2.1 0/5] QMP queue Peter Maydell
  5 siblings, 0 replies; 7+ messages in thread
From: Luiz Capitulino @ 2014-07-24 14:17 UTC (permalink / raw)
  To: peter.maydell; +Cc: qemu-devel, anthony

From: Eric Blake <eblake@redhat.com>

The POWERDOWN event was first documented in 0aab9ec3.  But since
dfab4892 later restored this file to the state prior to qmp events,
and we never documented it in the past, anyone using this file
instead of qapi will miss out on this event.  Tweak the existing
wording of SHUTDOWN to match 84321831, and make the difference
between the two events apparent.

* docs/qmp/qmp-events.txt (POWERDOWN): Add.
(SHUTDOWN): Tweak.

Signed-off-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Wenchao Xia <wenchaoqemu@gmail.com>
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
---
 docs/qmp/qmp-events.txt | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/docs/qmp/qmp-events.txt b/docs/qmp/qmp-events.txt
index 22d552f..9d7439e 100644
--- a/docs/qmp/qmp-events.txt
+++ b/docs/qmp/qmp-events.txt
@@ -243,6 +243,19 @@ Data:
   "timestamp": { "seconds": 1368697518, "microseconds": 326866 } }
 }
 
+POWERDOWN
+---------
+
+Emitted when the Virtual Machine is powered down through the power
+control system, such as via ACPI.
+
+Data: None.
+
+Example:
+
+{ "event": "POWERDOWN",
+    "timestamp": { "seconds": 1267040730, "microseconds": 682951 } }
+
 QUORUM_FAILURE
 --------------
 
@@ -325,7 +338,8 @@ Example:
 SHUTDOWN
 --------
 
-Emitted when the Virtual Machine is powered down.
+Emitted when the Virtual Machine has shut down, indicating that qemu
+is about to exit.
 
 Data: None.
 
-- 
1.9.3

^ permalink raw reply related	[flat|nested] 7+ messages in thread

* [Qemu-devel] [PULL 5/5] docs: document missing VSERPORT_CHANGE event
  2014-07-24 14:17 [Qemu-devel] [PULL for-2.1 0/5] QMP queue Luiz Capitulino
                   ` (3 preceding siblings ...)
  2014-07-24 14:17 ` [Qemu-devel] [PULL 4/5] docs: document missing POWERDOWN event Luiz Capitulino
@ 2014-07-24 14:17 ` Luiz Capitulino
  2014-07-24 16:16 ` [Qemu-devel] [PULL for-2.1 0/5] QMP queue Peter Maydell
  5 siblings, 0 replies; 7+ messages in thread
From: Luiz Capitulino @ 2014-07-24 14:17 UTC (permalink / raw)
  To: peter.maydell; +Cc: qemu-devel, anthony

From: Eric Blake <eblake@redhat.com>

The VSERPORT_CHANGE event was added in e2ae6159.  The patch for
this event was prepared at a time when this file was gone, even
though it got applied immediately after dfab4892 restored this
file.  Duplicate the documentation into this file, so that
anyone using this file instead of qapi will not miss out on this
new event.

* docs/qmp/qmp-events.txt (VSERPORT_CHANGE): Add.

Signed-off-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Wenchao Xia <wenchaoqemu@gmail.com>
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
---
 docs/qmp/qmp-events.txt | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/docs/qmp/qmp-events.txt b/docs/qmp/qmp-events.txt
index 9d7439e..d759d19 100644
--- a/docs/qmp/qmp-events.txt
+++ b/docs/qmp/qmp-events.txt
@@ -579,6 +579,22 @@ Example:
                     "host": "127.0.0.1", "sasl_username": "luiz" } },
         "timestamp": { "seconds": 1263475302, "microseconds": 150772 } }
 
+VSERPORT_CHANGE
+---------------
+
+Emitted when the guest opens or closes a virtio-serial port.
+
+Data:
+
+- "id": device identifier of the virtio-serial port (json-string)
+- "open": true if the guest has opened the virtio-serial port (json-bool)
+
+Example:
+
+{ "event": "VSERPORT_CHANGE",
+    "data": { "id": "channel0", "open": true },
+    "timestamp": { "seconds": 1401385907, "microseconds": 422329 } }
+
 WAKEUP
 ------
 
-- 
1.9.3

^ permalink raw reply related	[flat|nested] 7+ messages in thread

* Re: [Qemu-devel] [PULL for-2.1 0/5] QMP queue
  2014-07-24 14:17 [Qemu-devel] [PULL for-2.1 0/5] QMP queue Luiz Capitulino
                   ` (4 preceding siblings ...)
  2014-07-24 14:17 ` [Qemu-devel] [PULL 5/5] docs: document missing VSERPORT_CHANGE event Luiz Capitulino
@ 2014-07-24 16:16 ` Peter Maydell
  5 siblings, 0 replies; 7+ messages in thread
From: Peter Maydell @ 2014-07-24 16:16 UTC (permalink / raw)
  To: Luiz Capitulino; +Cc: QEMU Developers, Anthony Liguori

On 24 July 2014 15:17, Luiz Capitulino <lcapitulino@redhat.com> wrote:
> Doc fixes, zero regression risk for code.
>
> The following changes since commit a537d373b9f330853006ceb18d5891541b9e4030:
>
>   Merge remote-tracking branch 'remotes/kraxel/tags/pull-usb-20140723-1' into staging (2014-07-24 12:49:54 +0100)
>
> are available in the git repository at:
>
>
>   git://repo.or.cz/qemu/qmp-unstable.git queue/qmp
>
> for you to fetch changes up to 032baddea36330384b3654fcbfafa74cc815471c:
>
>   docs: document missing VSERPORT_CHANGE event (2014-07-24 10:00:33 -0400)
>
> ----------------------------------------------------------------
> Eric Blake (5):
>       docs: grammar fixes to qmp-events
>       docs: split SPICE_* event docs
>       docs: document missing SPICE_MIGRATE_COMPLETED event
>       docs: document missing POWERDOWN event
>       docs: document missing VSERPORT_CHANGE event
>
>  docs/qmp/qmp-events.txt | 80 +++++++++++++++++++++++++++++++++++++++++++++----
>  1 file changed, 74 insertions(+), 6 deletions(-)

Applied, thanks.

-- PMM

^ permalink raw reply	[flat|nested] 7+ messages in thread

end of thread, other threads:[~2014-07-24 16:16 UTC | newest]

Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-07-24 14:17 [Qemu-devel] [PULL for-2.1 0/5] QMP queue Luiz Capitulino
2014-07-24 14:17 ` [Qemu-devel] [PULL 1/5] docs: grammar fixes to qmp-events Luiz Capitulino
2014-07-24 14:17 ` [Qemu-devel] [PULL 2/5] docs: split SPICE_* event docs Luiz Capitulino
2014-07-24 14:17 ` [Qemu-devel] [PULL 3/5] docs: document missing SPICE_MIGRATE_COMPLETED event Luiz Capitulino
2014-07-24 14:17 ` [Qemu-devel] [PULL 4/5] docs: document missing POWERDOWN event Luiz Capitulino
2014-07-24 14:17 ` [Qemu-devel] [PULL 5/5] docs: document missing VSERPORT_CHANGE event Luiz Capitulino
2014-07-24 16:16 ` [Qemu-devel] [PULL for-2.1 0/5] QMP queue Peter Maydell

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).