From 5807ff88b1c97052a979050ff8f4246d7dfdc764 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Fri, 13 Jan 2017 15:41:21 +0100 Subject: qapi: Reorder doc comments for future doc generator The doc generator we're going to add expects a fairly rigid doc comment structure. Reorder / rephrase some doc comments to please it. Signed-off-by: Marc-André Lureau Message-Id: <20170113144135.5150-8-marcandre.lureau@redhat.com> Reviewed-by: Markus Armbruster [Commit message rewritten] Signed-off-by: Markus Armbruster --- qapi/event.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'qapi/event.json') diff --git a/qapi/event.json b/qapi/event.json index 37bf34ed6d..c7689b211d 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -272,9 +272,9 @@ # # Emitted when guest executes ACPI _OST method. # -# Since: 2.1 -# # @info: ACPIOSTInfo type as described in qapi-schema.json +# +# Since: 2.1 ## { 'event': 'ACPI_DEVICE_OST', 'data': { 'info': 'ACPIOSTInfo' } } -- cgit v1.2.3-55-g7522 From d3a48372a42c62608c2f773376810e6a9c1851fb Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Fri, 13 Jan 2017 15:41:23 +0100 Subject: qapi: add some sections in docs Add some more section titles to organize the documentation we're going to generate. Signed-off-by: Marc-André Lureau Reviewed-by: Markus Armbruster Message-Id: <20170113144135.5150-10-marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster --- qapi-schema.json | 4 ++++ qapi/block-core.json | 6 ++++-- qapi/block.json | 10 ++++++++-- qapi/common.json | 6 ++++-- qapi/crypto.json | 5 ++++- qapi/event.json | 6 ++++++ qapi/rocker.json | 4 ++++ qapi/trace.json | 3 +++ 8 files changed, 37 insertions(+), 7 deletions(-) (limited to 'qapi/event.json') diff --git a/qapi-schema.json b/qapi-schema.json index a1ceb71bbb..8744b1b774 100644 --- a/qapi-schema.json +++ b/qapi-schema.json @@ -20,6 +20,10 @@ # QAPI introspection { 'include': 'qapi/introspect.json' } +## +# = QMP commands +## + ## # @qmp_capabilities: # diff --git a/qapi/block-core.json b/qapi/block-core.json index fb5034c3a9..7f7f10bb49 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -1,6 +1,8 @@ # -*- Mode: Python -*- -# -# QAPI block core definitions (vm unrelated) + +## +# == QAPI block core definitions (vm unrelated) +## # QAPI common definitions { 'include': 'common.json' } diff --git a/qapi/block.json b/qapi/block.json index 8e9f59019a..693e234779 100644 --- a/qapi/block.json +++ b/qapi/block.json @@ -1,10 +1,16 @@ # -*- Mode: Python -*- -# -# QAPI block definitions (vm related) + +## +# = QAPI block definitions +## # QAPI block core definitions { 'include': 'block-core.json' } +## +# == QAPI block definitions (vm unrelated) +## + ## # @BiosAtaTranslation: # diff --git a/qapi/common.json b/qapi/common.json index 624a8619c8..d93f159946 100644 --- a/qapi/common.json +++ b/qapi/common.json @@ -1,6 +1,8 @@ # -*- Mode: Python -*- -# -# QAPI common definitions + +## +# = QAPI common definitions +## ## # @QapiErrorClass: diff --git a/qapi/crypto.json b/qapi/crypto.json index f4fd93b813..93a04743ea 100644 --- a/qapi/crypto.json +++ b/qapi/crypto.json @@ -1,6 +1,9 @@ # -*- Mode: Python -*- # -# QAPI crypto definitions + +## +# = QAPI crypto definitions +## ## # @QCryptoTLSCredsEndpoint: diff --git a/qapi/event.json b/qapi/event.json index c7689b211d..0cd4b79ad8 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -1,3 +1,9 @@ +# -*- Mode: Python -*- + +## +# = Other events +## + ## # @SHUTDOWN: # diff --git a/qapi/rocker.json b/qapi/rocker.json index ace27760f1..1e511cd37a 100644 --- a/qapi/rocker.json +++ b/qapi/rocker.json @@ -1,3 +1,7 @@ +## +# = Rocker switch device +## + ## # @RockerSwitch: # diff --git a/qapi/trace.json b/qapi/trace.json index 4fd39b7792..3ad7df7fdb 100644 --- a/qapi/trace.json +++ b/qapi/trace.json @@ -5,6 +5,9 @@ # This work is licensed under the terms of the GNU GPL, version 2 or later. # See the COPYING file in the top-level directory. +## +# = Tracing commands +## ## # @TraceEventState: -- cgit v1.2.3-55-g7522 From 12defe50f8c2339fda4c6f9d2c45710e9d31ecda Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:11:21 +0200 Subject: qmp-events: move 'SHUTDOWN' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 16 ---------------- qapi/event.json | 6 ++++++ 2 files changed, 6 insertions(+), 16 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 7cae0aa899..ab0f58ea9b 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -221,22 +221,6 @@ Example: Note: this event is rate-limited. -SHUTDOWN --------- - -Emitted when the Virtual Machine has shut down, indicating that qemu -is about to exit. - -Data: None. - -Example: - -{ "event": "SHUTDOWN", - "timestamp": { "seconds": 1267040730, "microseconds": 682951 } } - -Note: If the command-line option "-no-shutdown" has been specified, a STOP -event will eventually follow the SHUTDOWN event. - SPICE_CONNECTED --------------- diff --git a/qapi/event.json b/qapi/event.json index 0cd4b79ad8..6e8fd1a122 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -14,6 +14,12 @@ # not exit, and a STOP event will eventually follow the SHUTDOWN event # # Since: 0.12.0 +# +# Example: +# +# <- { "event": "SHUTDOWN", +# "timestamp": { "seconds": 1267040730, "microseconds": 682951 } } +# ## { 'event': 'SHUTDOWN' } -- cgit v1.2.3-55-g7522 From 189d43bed6c08855b6a12b889264f09f5af012a7 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:17:22 +0200 Subject: qmp-events: move 'POWERDOWN' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 13 ------------- qapi/event.json | 6 ++++++ 2 files changed, 6 insertions(+), 13 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index ab0f58ea9b..44840cea6f 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -114,19 +114,6 @@ 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 -------------- diff --git a/qapi/event.json b/qapi/event.json index 6e8fd1a122..ea3e4ee9e8 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -30,6 +30,12 @@ # system, such as via ACPI. # # Since: 0.12.0 +# +# Example: +# +# <- { "event": "POWERDOWN", +# "timestamp": { "seconds": 1267040730, "microseconds": 682951 } } +# ## { 'event': 'POWERDOWN' } -- cgit v1.2.3-55-g7522 From 7a2aae7a364db27924702bd4b284398bdd01240a Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:18:09 +0200 Subject: qmp-events: move 'RESET' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 12 ------------ qapi/event.json | 6 ++++++ 2 files changed, 6 insertions(+), 12 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 44840cea6f..c5a165a981 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -166,18 +166,6 @@ Flush operation: Note: this event is rate-limited. -RESET ------ - -Emitted when the Virtual Machine is reset. - -Data: None. - -Example: - -{ "event": "RESET", - "timestamp": { "seconds": 1267041653, "microseconds": 9518 } } - RESUME ------ diff --git a/qapi/event.json b/qapi/event.json index ea3e4ee9e8..da9898dce2 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -45,6 +45,12 @@ # Emitted when the virtual machine is reset # # Since: 0.12.0 +# +# Example: +# +# <- { "event": "RESET", +# "timestamp": { "seconds": 1267041653, "microseconds": 9518 } } +# ## { 'event': 'RESET' } -- cgit v1.2.3-55-g7522 From 138c454c0f2cdb5145cdd4762d5f6e8b8093da0e Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:18:36 +0200 Subject: qmp-events: move 'STOP' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 12 ------------ qapi/event.json | 6 ++++++ 2 files changed, 6 insertions(+), 12 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index c5a165a981..b826641aaf 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -324,18 +324,6 @@ Example: {"timestamp": {"seconds": 1449669631, "microseconds": 239225}, "event": "MIGRATION_PASS", "data": {"pass": 2}} -STOP ----- - -Emitted when the Virtual Machine is stopped. - -Data: None. - -Example: - -{ "event": "STOP", - "timestamp": { "seconds": 1267041730, "microseconds": 281295 } } - SUSPEND ------- diff --git a/qapi/event.json b/qapi/event.json index da9898dce2..eb41d808c1 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -60,6 +60,12 @@ # Emitted when the virtual machine is stopped # # Since: 0.12.0 +# +# Example: +# +# <- { "event": "STOP", +# "timestamp": { "seconds": 1267041730, "microseconds": 281295 } } +# ## { 'event': 'STOP' } -- cgit v1.2.3-55-g7522 From a2235a0499c799552a4ea330350acc0d71217f9f Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:22:10 +0200 Subject: qmp-events: move 'RESUME' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 12 ------------ qapi/event.json | 6 ++++++ 2 files changed, 6 insertions(+), 12 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index b826641aaf..27f9e59ef5 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -166,18 +166,6 @@ Flush operation: Note: this event is rate-limited. -RESUME ------- - -Emitted when the Virtual Machine resumes execution. - -Data: None. - -Example: - -{ "event": "RESUME", - "timestamp": { "seconds": 1271770767, "microseconds": 582542 } } - RTC_CHANGE ---------- diff --git a/qapi/event.json b/qapi/event.json index eb41d808c1..215bb8076c 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -75,6 +75,12 @@ # Emitted when the virtual machine resumes execution # # Since: 0.12.0 +# +# Example: +# +# <- { "event": "RESUME", +# "timestamp": { "seconds": 1271770767, "microseconds": 582542 } } +# ## { 'event': 'RESUME' } -- cgit v1.2.3-55-g7522 From 6f3cc5406b4c3383d017cb3540160eb49e659abb Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:22:38 +0200 Subject: qmp-events: move 'SUSPEND' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 12 ------------ qapi/event.json | 6 ++++++ 2 files changed, 6 insertions(+), 12 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 27f9e59ef5..2e3a22aabb 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -312,18 +312,6 @@ Example: {"timestamp": {"seconds": 1449669631, "microseconds": 239225}, "event": "MIGRATION_PASS", "data": {"pass": 2}} -SUSPEND -------- - -Emitted when guest enters S3 state. - -Data: None. - -Example: - -{ "event": "SUSPEND", - "timestamp": { "seconds": 1344456160, "microseconds": 309119 } } - SUSPEND_DISK ------------ diff --git a/qapi/event.json b/qapi/event.json index 215bb8076c..34e046769e 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -91,6 +91,12 @@ # which is sometimes called standby state # # Since: 1.1 +# +# Example: +# +# <- { "event": "SUSPEND", +# "timestamp": { "seconds": 1344456160, "microseconds": 309119 } } +# ## { 'event': 'SUSPEND' } -- cgit v1.2.3-55-g7522 From 4de62c38a530af909171452d121a2eee9102bf65 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:23:22 +0200 Subject: qmp-events: move 'SUSPEND_DISK' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 14 -------------- qapi/event.json | 6 ++++++ 2 files changed, 6 insertions(+), 14 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 2e3a22aabb..83f03557ee 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -312,20 +312,6 @@ Example: {"timestamp": {"seconds": 1449669631, "microseconds": 239225}, "event": "MIGRATION_PASS", "data": {"pass": 2}} -SUSPEND_DISK ------------- - -Emitted when the guest makes a request to enter S4 state. - -Data: None. - -Example: - -{ "event": "SUSPEND_DISK", - "timestamp": { "seconds": 1344456160, "microseconds": 309119 } } - -Note: QEMU shuts down when entering S4 state. - VNC_CONNECTED ------------- diff --git a/qapi/event.json b/qapi/event.json index 34e046769e..a3792cd2fa 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -109,6 +109,12 @@ # Note: QEMU shuts down (similar to event @SHUTDOWN) when entering this state # # Since: 1.2 +# +# Example: +# +# <- { "event": "SUSPEND_DISK", +# "timestamp": { "seconds": 1344456160, "microseconds": 309119 } } +# ## { 'event': 'SUSPEND_DISK' } -- cgit v1.2.3-55-g7522 From aa496f9812a7fb880f8782c8c3956183e759fbf0 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:24:25 +0200 Subject: qmp-events: move 'WAKEUP' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 12 ------------ qapi/event.json | 6 ++++++ 2 files changed, 6 insertions(+), 12 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 83f03557ee..8e709ea84c 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -420,18 +420,6 @@ Example: Note: this event is rate-limited separately for each "id". -WAKEUP ------- - -Emitted when the guest has woken up from S3 and is running. - -Data: None. - -Example: - -{ "event": "WAKEUP", - "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } - WATCHDOG -------- diff --git a/qapi/event.json b/qapi/event.json index a3792cd2fa..3ac4eb148f 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -124,6 +124,12 @@ # Emitted when the guest has woken up from suspend state and is running # # Since: 1.1 +# +# Example: +# +# <- { "event": "WAKEUP", +# "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } +# ## { 'event': 'WAKEUP' } -- cgit v1.2.3-55-g7522 From 73c41bfd314fe3319e35325162a7e9ded310fc4f Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:25:25 +0200 Subject: qmp-events: move 'RTC_CHANGE' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 18 ------------------ qapi/event.json | 9 +++++++++ 2 files changed, 9 insertions(+), 18 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 8e709ea84c..35760649aa 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -166,24 +166,6 @@ Flush operation: Note: this event is rate-limited. -RTC_CHANGE ----------- - -Emitted when the guest changes the RTC time. - -Data: - -- "offset": Offset between base RTC clock (as specified by -rtc base), and -new RTC clock value (json-number) - -Example: - -{ "event": "RTC_CHANGE", - "data": { "offset": 78 }, - "timestamp": { "seconds": 1267020223, "microseconds": 435656 } } - -Note: this event is rate-limited. - SPICE_CONNECTED --------------- diff --git a/qapi/event.json b/qapi/event.json index 3ac4eb148f..e2ab2c760a 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -141,7 +141,16 @@ # @offset: offset between base RTC clock (as specified by -rtc base), and # new RTC clock value # +# Note: This event is rate-limited. +# # Since: 0.13.0 +# +# Example: +# +# <- { "event": "RTC_CHANGE", +# "data": { "offset": 78 }, +# "timestamp": { "seconds": 1267020223, "microseconds": 435656 } } +# ## { 'event': 'RTC_CHANGE', 'data': { 'offset': 'int' } } -- cgit v1.2.3-55-g7522 From 9ba5cec9dd68ac1b38fbb7ab45f389e5e05b89f1 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:26:36 +0200 Subject: qmp-events: move 'WATCHDOG' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 21 --------------------- qapi/event.json | 9 +++++++++ 2 files changed, 9 insertions(+), 21 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 35760649aa..fbcf4f83f1 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -401,24 +401,3 @@ Example: "timestamp": { "seconds": 1401385907, "microseconds": 422329 } } Note: this event is rate-limited separately for each "id". - -WATCHDOG --------- - -Emitted when the watchdog device's timer is expired. - -Data: - -- "action": Action that has been taken, it's one of the following (json-string): - "reset", "shutdown", "poweroff", "pause", "debug", or "none" - -Example: - -{ "event": "WATCHDOG", - "data": { "action": "reset" }, - "timestamp": { "seconds": 1267061043, "microseconds": 959568 } } - -Note: If action is "reset", "shutdown", or "pause" the WATCHDOG event is -followed respectively by the RESET, SHUTDOWN, or STOP events. - -Note: this event is rate-limited. diff --git a/qapi/event.json b/qapi/event.json index e2ab2c760a..43d27ecbeb 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -165,7 +165,16 @@ # Note: If action is "reset", "shutdown", or "pause" the WATCHDOG event is # followed respectively by the RESET, SHUTDOWN, or STOP events # +# Note: This event is rate-limited. +# # Since: 0.13.0 +# +# Example: +# +# <- { "event": "WATCHDOG", +# "data": { "action": "reset" }, +# "timestamp": { "seconds": 1267061043, "microseconds": 959568 } } +# ## { 'event': 'WATCHDOG', 'data': { 'action': 'WatchdogExpirationAction' } } -- cgit v1.2.3-55-g7522 From cdc94a1b3e7e2616363ee837dea1724062370669 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:27:18 +0200 Subject: qmp-events: move 'DEVICE_DELETED' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 18 ------------------ qapi/event.json | 8 ++++++++ 2 files changed, 8 insertions(+), 18 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index fbcf4f83f1..c19177d466 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -30,24 +30,6 @@ Example: Note: this event is rate-limited. -DEVICE_DELETED --------------- - -Emitted whenever the device removal completion is acknowledged -by the guest. -At this point, it's safe to reuse the specified device ID. -Device removal can be initiated by the guest or by HMP/QMP commands. - -Data: - -- "device": device name (json-string, optional) -- "path": device path (json-string) - -{ "event": "DEVICE_DELETED", - "data": { "device": "virtio-net-pci-0", - "path": "/machine/peripheral/virtio-net-pci-0" }, - "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } - DUMP_COMPLETED -------------- diff --git a/qapi/event.json b/qapi/event.json index 43d27ecbeb..55ed7ec3c4 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -191,6 +191,14 @@ # @path: device path # # Since: 1.5 +# +# Example: +# +# <- { "event": "DEVICE_DELETED", +# "data": { "device": "virtio-net-pci-0", +# "path": "/machine/peripheral/virtio-net-pci-0" }, +# "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } +# ## { 'event': 'DEVICE_DELETED', 'data': { '*device': 'str', 'path': 'str' } } -- cgit v1.2.3-55-g7522 From 5dbdcf43243497f5350b311aff98dcf583bfdbc2 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:28:39 +0200 Subject: qmp-events: move 'NIC_RX_FILTER_CHANGED' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 17 ----------------- qapi/event.json | 9 +++++++++ 2 files changed, 9 insertions(+), 17 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index c19177d466..a4323f9489 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -79,23 +79,6 @@ Example: }, "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } -NIC_RX_FILTER_CHANGED ---------------------- - -The event is emitted once until the query command is executed, -the first event will always be emitted. - -Data: - -- "name": net client name (json-string) -- "path": device path (json-string) - -{ "event": "NIC_RX_FILTER_CHANGED", - "data": { "name": "vnet0", - "path": "/machine/peripheral/vnet0/virtio-backend" }, - "timestamp": { "seconds": 1368697518, "microseconds": 326866 } } -} - QUORUM_FAILURE -------------- diff --git a/qapi/event.json b/qapi/event.json index 55ed7ec3c4..84b761ae3d 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -214,6 +214,15 @@ # @path: device path # # Since: 1.6 +# +# Example: +# +# <- { "event": "NIC_RX_FILTER_CHANGED", +# "data": { "name": "vnet0", +# "path": "/machine/peripheral/vnet0/virtio-backend" }, +# "timestamp": { "seconds": 1368697518, "microseconds": 326866 } } +# } +# ## { 'event': 'NIC_RX_FILTER_CHANGED', 'data': { '*name': 'str', 'path': 'str' } } -- cgit v1.2.3-55-g7522 From f46052fd139d8990c0d6395b563972ca1f2cf2fe Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:29:24 +0200 Subject: qmp-events: move 'VNC_CONNECTED' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 31 ------------------------------- qapi/event.json | 11 +++++++++++ 2 files changed, 11 insertions(+), 31 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index a4323f9489..f0eb626456 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -259,37 +259,6 @@ Example: {"timestamp": {"seconds": 1449669631, "microseconds": 239225}, "event": "MIGRATION_PASS", "data": {"pass": 2}} -VNC_CONNECTED -------------- - -Emitted when a VNC client establishes a connection. - -Data: - -- "server": Server information (json-object) - - "host": IP address (json-string) - - "service": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - - "auth": authentication method (json-string, optional) -- "client": Client information (json-object) - - "host": IP address (json-string) - - "service": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - -Example: - -{ "event": "VNC_CONNECTED", - "data": { - "server": { "auth": "sasl", "family": "ipv4", - "service": "5901", "host": "0.0.0.0" }, - "client": { "family": "ipv4", "service": "58425", - "host": "127.0.0.1" } }, - "timestamp": { "seconds": 1262976601, "microseconds": 975795 } } - - -Note: This event is emitted before any authentication takes place, thus -the authentication ID is not provided. - VNC_DISCONNECTED ---------------- diff --git a/qapi/event.json b/qapi/event.json index 84b761ae3d..ffb07c92fc 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -240,6 +240,17 @@ # the authentication ID is not provided # # Since: 0.13.0 +# +# Example: +# +# <- { "event": "VNC_CONNECTED", +# "data": { +# "server": { "auth": "sasl", "family": "ipv4", +# "service": "5901", "host": "0.0.0.0" }, +# "client": { "family": "ipv4", "service": "58425", +# "host": "127.0.0.1" } }, +# "timestamp": { "seconds": 1262976601, "microseconds": 975795 } } +# ## { 'event': 'VNC_CONNECTED', 'data': { 'server': 'VncServerInfo', -- cgit v1.2.3-55-g7522 From 99ab2471a438ec3f9041c80cbdd412f19949cc18 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:29:59 +0200 Subject: qmp-events: move 'VNC_INITIALIZED' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 30 ------------------------------ qapi/event.json | 11 +++++++++++ 2 files changed, 11 insertions(+), 30 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index f0eb626456..1bc7672d40 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -288,36 +288,6 @@ Example: "host": "127.0.0.1", "sasl_username": "luiz" } }, "timestamp": { "seconds": 1262976601, "microseconds": 975795 } } -VNC_INITIALIZED ---------------- - -Emitted after authentication takes place (if any) and the VNC session is -made active. - -Data: - -- "server": Server information (json-object) - - "host": IP address (json-string) - - "service": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - - "auth": authentication method (json-string, optional) -- "client": Client information (json-object) - - "host": IP address (json-string) - - "service": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - - "x509_dname": TLS dname (json-string, optional) - - "sasl_username": SASL username (json-string, optional) - -Example: - -{ "event": "VNC_INITIALIZED", - "data": { - "server": { "auth": "sasl", "family": "ipv4", - "service": "5901", "host": "0.0.0.0"}, - "client": { "family": "ipv4", "service": "46089", - "host": "127.0.0.1", "sasl_username": "luiz" } }, - "timestamp": { "seconds": 1263475302, "microseconds": 150772 } } - VSERPORT_CHANGE --------------- diff --git a/qapi/event.json b/qapi/event.json index ffb07c92fc..72edcba24d 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -267,6 +267,17 @@ # @client: client information # # Since: 0.13.0 +# +# Example: +# +# <- { "event": "VNC_INITIALIZED", +# "data": { +# "server": { "auth": "sasl", "family": "ipv4", +# "service": "5901", "host": "0.0.0.0"}, +# "client": { "family": "ipv4", "service": "46089", +# "host": "127.0.0.1", "sasl_username": "luiz" } }, +# "timestamp": { "seconds": 1263475302, "microseconds": 150772 } } +# ## { 'event': 'VNC_INITIALIZED', 'data': { 'server': 'VncServerInfo', -- cgit v1.2.3-55-g7522 From 659789ba365bfc99210adf5347a28dc3f977e727 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:30:33 +0200 Subject: qmp-events: move 'VNC_DISCONNECTED' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 29 ----------------------------- qapi/event.json | 11 +++++++++++ 2 files changed, 11 insertions(+), 29 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 1bc7672d40..c9d44f3146 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -259,35 +259,6 @@ Example: {"timestamp": {"seconds": 1449669631, "microseconds": 239225}, "event": "MIGRATION_PASS", "data": {"pass": 2}} -VNC_DISCONNECTED ----------------- - -Emitted when the connection is closed. - -Data: - -- "server": Server information (json-object) - - "host": IP address (json-string) - - "service": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - - "auth": authentication method (json-string, optional) -- "client": Client information (json-object) - - "host": IP address (json-string) - - "service": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - - "x509_dname": TLS dname (json-string, optional) - - "sasl_username": SASL username (json-string, optional) - -Example: - -{ "event": "VNC_DISCONNECTED", - "data": { - "server": { "auth": "sasl", "family": "ipv4", - "service": "5901", "host": "0.0.0.0" }, - "client": { "family": "ipv4", "service": "58425", - "host": "127.0.0.1", "sasl_username": "luiz" } }, - "timestamp": { "seconds": 1262976601, "microseconds": 975795 } } - VSERPORT_CHANGE --------------- diff --git a/qapi/event.json b/qapi/event.json index 72edcba24d..9f380ee2b4 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -293,6 +293,17 @@ # @client: client information # # Since: 0.13.0 +# +# Example: +# +# <- { "event": "VNC_DISCONNECTED", +# "data": { +# "server": { "auth": "sasl", "family": "ipv4", +# "service": "5901", "host": "0.0.0.0" }, +# "client": { "family": "ipv4", "service": "58425", +# "host": "127.0.0.1", "sasl_username": "luiz" } }, +# "timestamp": { "seconds": 1262976601, "microseconds": 975795 } } +# ## { 'event': 'VNC_DISCONNECTED', 'data': { 'server': 'VncServerInfo', -- cgit v1.2.3-55-g7522 From 5db6670347d3e599ee1e82f6400bbf387e129b98 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:31:17 +0200 Subject: qmp-events: move 'SPICE_CONNECTED' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 25 ------------------------- qapi/event.json | 10 ++++++++++ 2 files changed, 10 insertions(+), 25 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index c9d44f3146..5c121c55ac 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -131,31 +131,6 @@ Flush operation: Note: this event is rate-limited. -SPICE_CONNECTED ---------------- - -Emitted when a SPICE client connects. - -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_CONNECTED", - "data": { - "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"}, - "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"} -}} - SPICE_DISCONNECTED ------------------ diff --git a/qapi/event.json b/qapi/event.json index 9f380ee2b4..5c971a45de 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -319,6 +319,16 @@ # @client: client information # # Since: 0.14.0 +# +# Example: +# +# <- { "timestamp": {"seconds": 1290688046, "microseconds": 388707}, +# "event": "SPICE_CONNECTED", +# "data": { +# "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"}, +# "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"} +# }} +# ## { 'event': 'SPICE_CONNECTED', 'data': { 'server': 'SpiceBasicInfo', -- cgit v1.2.3-55-g7522 From da08e2a5a2a6ba5956bee1158f9ac2fc2ce364b8 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:31:52 +0200 Subject: qmp-events: move 'SPICE_INITIALIZED' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 37 ------------------------------------- qapi/event.json | 12 ++++++++++++ 2 files changed, 12 insertions(+), 37 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 5c121c55ac..bca0f540e4 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -156,43 +156,6 @@ Example: "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"} }} -SPICE_INITIALIZED ------------------ - -Emitted after initial handshake and authentication takes place (if any) -and the SPICE channel is up and running - -Data: - -- "server": Server information (json-object) - - "host": IP address (json-string) - - "port": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - - "auth": authentication method (json-string, optional) -- "client": Client information (json-object) - - "host": IP address (json-string) - - "port": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - - "connection-id": spice connection id. All channels with the same id - belong to the same spice session (json-int) - - "channel-type": channel type. "1" is the main control channel, filter for - this one if you want track spice sessions only (json-int) - - "channel-id": channel id. Usually "0", might be different needed when - multiple channels of the same type exist, such as multiple - display channels in a multihead setup (json-int) - - "tls": whevener the channel is encrypted (json-bool) - -Example: - -{ "timestamp": {"seconds": 1290688046, "microseconds": 417172}, - "event": "SPICE_INITIALIZED", - "data": {"server": {"auth": "spice", "port": "5921", - "family": "ipv4", "host": "127.0.0.1"}, - "client": {"port": "49004", "family": "ipv4", "channel-type": 3, - "connection-id": 1804289383, "host": "127.0.0.1", - "channel-id": 0, "tls": true} -}} - SPICE_MIGRATE_COMPLETED ----------------------- diff --git a/qapi/event.json b/qapi/event.json index 5c971a45de..c1f026cce4 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -345,6 +345,18 @@ # @client: client information # # Since: 0.14.0 +# +# Example: +# +# <- { "timestamp": {"seconds": 1290688046, "microseconds": 417172}, +# "event": "SPICE_INITIALIZED", +# "data": {"server": {"auth": "spice", "port": "5921", +# "family": "ipv4", "host": "127.0.0.1"}, +# "client": {"port": "49004", "family": "ipv4", "channel-type": 3, +# "connection-id": 1804289383, "host": "127.0.0.1", +# "channel-id": 0, "tls": true} +# }} +# ## { 'event': 'SPICE_INITIALIZED', 'data': { 'server': 'SpiceServerInfo', -- cgit v1.2.3-55-g7522 From 93ab0fc3c3d4884c475fa452a41e9c4bd1d693d6 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:32:29 +0200 Subject: qmp-events: move 'SPICE_DISCONNECTED' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 25 ------------------------- qapi/event.json | 10 ++++++++++ 2 files changed, 10 insertions(+), 25 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index bca0f540e4..8fa3c23683 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -131,31 +131,6 @@ Flush operation: Note: this event is rate-limited. -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_MIGRATE_COMPLETED ----------------------- diff --git a/qapi/event.json b/qapi/event.json index c1f026cce4..bbab069bec 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -372,6 +372,16 @@ # @client: client information # # Since: 0.14.0 +# +# 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"} +# }} +# ## { 'event': 'SPICE_DISCONNECTED', 'data': { 'server': 'SpiceBasicInfo', -- cgit v1.2.3-55-g7522 From e6bcb080f965d0a71acd859c8a35e0652b5c366e Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:32:56 +0200 Subject: qmp-events: move 'SPICE_MIGRATE_COMPLETED' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 12 ------------ qapi/event.json | 6 ++++++ 2 files changed, 6 insertions(+), 12 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 8fa3c23683..0574a217c4 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -131,18 +131,6 @@ Flush operation: Note: this event is rate-limited. -SPICE_MIGRATE_COMPLETED ------------------------ - -Emitted when SPICE migration has completed - -Data: None. - -Example: - -{ "timestamp": {"seconds": 1290688046, "microseconds": 417172}, - "event": "SPICE_MIGRATE_COMPLETED" } - MIGRATION --------- diff --git a/qapi/event.json b/qapi/event.json index bbab069bec..5484324664 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -393,6 +393,12 @@ # Emitted when SPICE migration has completed # # Since: 1.3 +# +# Example: +# +# <- { "timestamp": {"seconds": 1290688046, "microseconds": 417172}, +# "event": "SPICE_MIGRATE_COMPLETED" } +# ## { 'event': 'SPICE_MIGRATE_COMPLETED' } -- cgit v1.2.3-55-g7522 From bce911ce263e78d13fad5415881a5310ead6c73f Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:33:23 +0200 Subject: qmp-events: move 'MIGRATION' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 15 --------------- qapi/event.json | 7 +++++++ 2 files changed, 7 insertions(+), 15 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 0574a217c4..d61ab1dabc 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -131,21 +131,6 @@ Flush operation: Note: this event is rate-limited. -MIGRATION ---------- - -Emitted when a migration event happens - -Data: None. - - - "status": migration status - See MigrationStatus in ~/qapi-schema.json for possible values - -Example: - -{"timestamp": {"seconds": 1432121972, "microseconds": 744001}, - "event": "MIGRATION", "data": {"status": "completed"}} - MIGRATION_PASS -------------- diff --git a/qapi/event.json b/qapi/event.json index 5484324664..ebf45cf7ed 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -410,6 +410,13 @@ # @status: @MigrationStatus describing the current migration status. # # Since: 2.4 +# +# Example: +# +# <- {"timestamp": {"seconds": 1432121972, "microseconds": 744001}, +# "event": "MIGRATION", +# "data": {"status": "completed"} } +# ## { 'event': 'MIGRATION', 'data': {'status': 'MigrationStatus'}} -- cgit v1.2.3-55-g7522 From 622b3a6a51ee6ecfd14f78a2b013c17b0e7c05fc Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:34:01 +0200 Subject: qmp-events: move 'ACPI_DEVICE_OST' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 10 ---------- qapi/event.json | 7 +++++++ 2 files changed, 7 insertions(+), 10 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index d61ab1dabc..2c7eccf1c3 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -1,16 +1,6 @@ QEMU Machine Protocol Events ============================ -ACPI_DEVICE_OST ---------------- - -Emitted when guest executes ACPI _OST method. - - - data: ACPIOSTInfo type as described in qapi-schema.json - -{ "event": "ACPI_DEVICE_OST", - "data": { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0 } } - BALLOON_CHANGE -------------- diff --git a/qapi/event.json b/qapi/event.json index ebf45cf7ed..e8e4edd364 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -442,6 +442,13 @@ # @info: ACPIOSTInfo type as described in qapi-schema.json # # Since: 2.1 +# +# Example: +# +# <- { "event": "ACPI_DEVICE_OST", +# "data": { "device": "d1", "slot": "0", +# "slot-type": "DIMM", "source": 1, "status": 0 } } +# ## { 'event': 'ACPI_DEVICE_OST', 'data': { 'info': 'ACPIOSTInfo' } } -- cgit v1.2.3-55-g7522 From a030dc00295438c56498032e93af42b19cbc94fb Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:34:34 +0200 Subject: qmp-events: move 'BALLOON_CHANGE' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 19 ------------------- qapi/event.json | 9 +++++++++ 2 files changed, 9 insertions(+), 19 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 2c7eccf1c3..9f6415d218 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -1,25 +1,6 @@ QEMU Machine Protocol Events ============================ -BALLOON_CHANGE --------------- - -Emitted when the guest changes the actual BALLOON level. This -value is equivalent to the 'actual' field return by the -'query-balloon' command - -Data: - -- "actual": actual level of the guest memory balloon in bytes (json-number) - -Example: - -{ "event": "BALLOON_CHANGE", - "data": { "actual": 944766976 }, - "timestamp": { "seconds": 1267020223, "microseconds": 435656 } } - -Note: this event is rate-limited. - DUMP_COMPLETED -------------- diff --git a/qapi/event.json b/qapi/event.json index e8e4edd364..c50147bbb5 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -461,7 +461,16 @@ # # @actual: actual level of the guest memory balloon in bytes # +# Note: this event is rate-limited. +# # Since: 1.2 +# +# Example: +# +# <- { "event": "BALLOON_CHANGE", +# "data": { "actual": 944766976 }, +# "timestamp": { "seconds": 1267020223, "microseconds": 435656 } } +# ## { 'event': 'BALLOON_CHANGE', 'data': { 'actual': 'int' } } -- cgit v1.2.3-55-g7522 From 449dbec15a39da4f8c2d7e9178a997c5b486f397 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:35:19 +0200 Subject: qmp-events: move 'GUEST_PANICKED' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 14 -------------- qapi/event.json | 6 ++++++ 2 files changed, 6 insertions(+), 14 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 9f6415d218..f8e777ce89 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -19,20 +19,6 @@ Example: "data": {"result": {"total": 1090650112, "status": "completed", "completed": 1090650112} } } -GUEST_PANICKED --------------- - -Emitted when guest OS panic is detected. - -Data: - -- "action": Action that has been taken (json-string, currently always "pause"). - -Example: - -{ "event": "GUEST_PANICKED", - "data": { "action": "pause" } } - MEM_UNPLUG_ERROR -------------------- Emitted when memory hot unplug error occurs. diff --git a/qapi/event.json b/qapi/event.json index c50147bbb5..c131a4ff20 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -483,6 +483,12 @@ # @action: action that has been taken, currently always "pause" # # Since: 1.5 +# +# Example: +# +# <- { "event": "GUEST_PANICKED", +# "data": { "action": "pause" } } +# ## { 'event': 'GUEST_PANICKED', 'data': { 'action': 'GuestPanicAction' } } -- cgit v1.2.3-55-g7522 From 9dcbe9a7e8e3bd40315c00682ff3f42b832dd435 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:36:17 +0200 Subject: qmp-events: move 'QUORUM_FAILURE' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 19 ------------------- qapi/event.json | 9 +++++++++ 2 files changed, 9 insertions(+), 19 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index f8e777ce89..c0a3bb8fd4 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -36,25 +36,6 @@ Example: }, "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } -QUORUM_FAILURE --------------- - -Emitted by the Quorum block driver if it fails to establish a quorum. - -Data: - -- "reference": device name if defined else node name. -- "sector-num": Number of the first sector of the failed read operation. -- "sectors-count": Failed read operation sector count. - -Example: - -{ "event": "QUORUM_FAILURE", - "data": { "reference": "usr1", "sector-num": 345435, "sectors-count": 5 }, - "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } - -Note: this event is rate-limited. - QUORUM_REPORT_BAD ----------------- diff --git a/qapi/event.json b/qapi/event.json index c131a4ff20..af69331c94 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -504,7 +504,16 @@ # # @sectors-count: failed read operation sector count # +# Note: This event is rate-limited. +# # Since: 2.0 +# +# Example: +# +# <- { "event": "QUORUM_FAILURE", +# "data": { "reference": "usr1", "sector-num": 345435, "sectors-count": 5 }, +# "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } +# ## { 'event': 'QUORUM_FAILURE', 'data': { 'reference': 'str', 'sector-num': 'int', 'sectors-count': 'int' } } -- cgit v1.2.3-55-g7522 From 2ee7fea7ce0306e39fa4bfed122c3fa0acf0bb02 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:38:12 +0200 Subject: qmp-events: move 'QUORUM_REPORT_BAD' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 33 --------------------------------- qapi/event.json | 19 +++++++++++++++++++ 2 files changed, 19 insertions(+), 33 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index c0a3bb8fd4..6f42640d5f 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -36,39 +36,6 @@ Example: }, "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } -QUORUM_REPORT_BAD ------------------ - -Emitted to report a corruption of a Quorum file. - -Data: - -- "type": Quorum operation type -- "error": Error message (json-string, optional) - Only present on failure. This field contains a human-readable - error message. There are no semantics other than that the - block layer reported an error and clients should not try to - interpret the error string. -- "node-name": The graph node name of the block driver state. -- "sector-num": Number of the first sector of the failed read operation. -- "sectors-count": Failed read operation sector count. - -Example: - -Read operation: -{ "event": "QUORUM_REPORT_BAD", - "data": { "node-name": "node0", "sector-num": 345435, "sectors-count": 5, - "type": "read" }, - "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } - -Flush operation: -{ "event": "QUORUM_REPORT_BAD", - "data": { "node-name": "node0", "sector-num": 0, "sectors-count": 2097120, - "type": "flush", "error": "Broken pipe" }, - "timestamp": { "seconds": 1456406829, "microseconds": 291763 } } - -Note: this event is rate-limited. - MIGRATION_PASS -------------- diff --git a/qapi/event.json b/qapi/event.json index af69331c94..5779d5d714 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -536,7 +536,26 @@ # # @sectors-count: failed read operation sector count # +# Note: This event is rate-limited. +# # Since: 2.0 +# +# Example: +# +# 1. Read operation +# +# { "event": "QUORUM_REPORT_BAD", +# "data": { "node-name": "node0", "sector-num": 345435, "sectors-count": 5, +# "type": "read" }, +# "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } +# +# 2. Flush operation +# +# { "event": "QUORUM_REPORT_BAD", +# "data": { "node-name": "node0", "sector-num": 0, "sectors-count": 2097120, +# "type": "flush", "error": "Broken pipe" }, +# "timestamp": { "seconds": 1456406829, "microseconds": 291763 } } +# ## { 'event': 'QUORUM_REPORT_BAD', 'data': { 'type': 'QuorumOpType', '*error': 'str', 'node-name': 'str', -- cgit v1.2.3-55-g7522 From 14df1ea1683a52decbe4664fba6a8aa139536f27 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:39:06 +0200 Subject: qmp-events: move 'VSERPORT_CHANGE' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 18 ------------------ qapi/event.json | 7 +++++++ 2 files changed, 7 insertions(+), 18 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 6f42640d5f..59743b569e 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -49,21 +49,3 @@ Data: None. Example: {"timestamp": {"seconds": 1449669631, "microseconds": 239225}, "event": "MIGRATION_PASS", "data": {"pass": 2}} - -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 } } - -Note: this event is rate-limited separately for each "id". diff --git a/qapi/event.json b/qapi/event.json index 5779d5d714..a9f974fa36 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -571,6 +571,13 @@ # @open: true if the guest has opened the virtio-serial port # # Since: 2.1 +# +# Example: +# +# <- { "event": "VSERPORT_CHANGE", +# "data": { "id": "channel0", "open": true }, +# "timestamp": { "seconds": 1401385907, "microseconds": 422329 } } +# ## { 'event': 'VSERPORT_CHANGE', 'data': { 'id': 'str', 'open': 'bool' } } -- cgit v1.2.3-55-g7522 From e602f0b4e7fc497c50a63732feeb9be7650cdaef Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:39:52 +0200 Subject: qmp-events: move 'MEM_UNPLUG_ERROR' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 17 ----------------- qapi/event.json | 9 +++++++++ 2 files changed, 9 insertions(+), 17 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 59743b569e..66a287e173 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -19,23 +19,6 @@ Example: "data": {"result": {"total": 1090650112, "status": "completed", "completed": 1090650112} } } -MEM_UNPLUG_ERROR --------------------- -Emitted when memory hot unplug error occurs. - -Data: - -- "device": device name (json-string) -- "msg": Informative message (e.g., reason for the error) (json-string) - -Example: - -{ "event": "MEM_UNPLUG_ERROR" - "data": { "device": "dimm1", - "msg": "acpi: device unplug for unsupported device" - }, - "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } - MIGRATION_PASS -------------- diff --git a/qapi/event.json b/qapi/event.json index a9f974fa36..f8c7dd6bb5 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -592,6 +592,15 @@ # @msg: Informative message # # Since: 2.4 +# +# Example: +# +# <- { "event": "MEM_UNPLUG_ERROR" +# "data": { "device": "dimm1", +# "msg": "acpi: device unplug for unsupported device" +# }, +# "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } +# ## { 'event': 'MEM_UNPLUG_ERROR', 'data': { 'device': 'str', 'msg': 'str' } } -- cgit v1.2.3-55-g7522 From a102a4acad6c1bc94942efbec18cf7f20bdac40e Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:45:03 +0200 Subject: qmp-events: move 'DUMP_COMPLETED' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 18 ------------------ qapi/event.json | 7 +++++++ 2 files changed, 7 insertions(+), 18 deletions(-) (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 66a287e173..d84be5fdd4 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -1,24 +1,6 @@ QEMU Machine Protocol Events ============================ -DUMP_COMPLETED --------------- - -Emitted when the guest has finished one memory dump. - -Data: - -- "result": DumpQueryResult type described in qapi-schema.json -- "error": Error message when dump failed. This is only a - human-readable string provided when dump failed. It should not be - parsed in any way (json-string, optional) - -Example: - -{ "event": "DUMP_COMPLETED", - "data": {"result": {"total": 1090650112, "status": "completed", - "completed": 1090650112} } } - MIGRATION_PASS -------------- diff --git a/qapi/event.json b/qapi/event.json index f8c7dd6bb5..9d1c2f9fe4 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -617,6 +617,13 @@ # user should not try to interpret the error string. # # Since: 2.6 +# +# Example: +# +# { "event": "DUMP_COMPLETED", +# "data": {"result": {"total": 1090650112, "status": "completed", +# "completed": 1090650112} } } +# ## { 'event': 'DUMP_COMPLETED' , 'data': { 'result': 'DumpQueryResult', '*error': 'str' } } -- cgit v1.2.3-55-g7522 From 231aaf3a8217443b518221719d1073c08f367225 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 16:45:54 +0200 Subject: qmp-events: move 'MIGRATION_PASS' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 16 ---------------- qapi/event.json | 6 ++++++ 2 files changed, 6 insertions(+), 16 deletions(-) delete mode 100644 docs/qmp-events.txt (limited to 'qapi/event.json') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt deleted file mode 100644 index d84be5fdd4..0000000000 --- a/docs/qmp-events.txt +++ /dev/null @@ -1,16 +0,0 @@ - QEMU Machine Protocol Events - ============================ - -MIGRATION_PASS --------------- - -Emitted from the source side of a migration at the start of each pass -(when it syncs the dirty bitmap) - -Data: None. - - - "pass": An incrementing count (starting at 1 on the first pass) - -Example: -{"timestamp": {"seconds": 1449669631, "microseconds": 239225}, - "event": "MIGRATION_PASS", "data": {"pass": 2}} diff --git a/qapi/event.json b/qapi/event.json index 9d1c2f9fe4..f3737b771f 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -430,6 +430,12 @@ # @pass: An incrementing count (starting at 1 on the first pass) # # Since: 2.6 +# +# Example: +# +# { "timestamp": {"seconds": 1449669631, "microseconds": 239225}, +# "event": "MIGRATION_PASS", "data": {"pass": 2} } +# ## { 'event': 'MIGRATION_PASS', 'data': { 'pass': 'int' } } -- cgit v1.2.3-55-g7522