Skip to contentSkip to conversation

Fix some qapi examples and a TODO section

PATCH Superseded Victor Toso 2 participants 21 messages Mar 25, 2022 – Mar 28, 2022

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

v2 cover Fix some qapi examples and a TODO section

I've being using the examples as unit tests and found a few that doesn't work out-of-the-box, might be inteded in order to be less verbose in the qapi documentation but nevertheless I'm sending this out in case you want to cherry-pick them.

* Changes in v2:
02/14: qapi: fix example of BLOCK_IMAGE_CORRUPTED event
- changed the example to an actual error picked from qemu-iotests/60.out
- added recent timestamp :)
03/14: qapi: fix example of BLOCK_IO_ERROR event
- use real error message, in this case "No space left on device"
04/14: qapi: fix example of BLOCK_JOB_PENDING event
- added an extra space
- added recent timestamp
07/14: qapi: fix example of UNPLUG_PRIMARY event
- amended commit message
08/14: qapi: fix example of FAILOVER_NEGOTIATED event
- fixed syntax for proper document parameter
09/14: qapi: run-state examples: add missing member
- fixed commit message
10/14: qapi: run-state examples: add missing timestamp
- added chronological timestamps ;)

Cheers,

Victor Toso (14):
qapi: BlockExportRemoveMode: move comments to TODO
qapi: fix example of BLOCK_IMAGE_CORRUPTED event
qapi: fix example of BLOCK_IO_ERROR event
qapi: fix example of BLOCK_JOB_PENDING event
qapi: fix example of DUMP_COMPLETED event
qapi: fix example of MEMORY_DEVICE_SIZE_CHANGE event
qapi: fix example of UNPLUG_PRIMARY event
qapi: fix example of FAILOVER_NEGOTIATED event
qapi: fix examples: SHUTDOWN and RESET events
qapi: run-state examples: add missing timestamp
qapi: fix example of MEMORY_FAILURE
qapi: ui examples: add missing websocket member
qapi: fix example of ACPI_DEVICE_OST event
qapi: fix example of dump-guest-memory

 qapi/acpi.json         |  5 +++--
 qapi/block-core.json   | 14 +++++++-------
 qapi/block-export.json | 10 +++++-----
 qapi/dump.json         |  9 +++++----
 qapi/machine.json      |  3 ++-
 qapi/migration.json    |  4 +++-
 qapi/net.json          |  6 ++++--
 qapi/run-state.json    | 16 +++++++++++-----
 qapi/ui.json           | 12 ++++++------
 9 files changed, 46 insertions(+), 33 deletions(-)
Signature · 1 line
2.35.1
#1 lore raw

PATCH v2 1/14 qapi: BlockExportRemoveMode: move comments to TODO

@hide and @soft are potential additions which fits the TODO section perfectly.

The main motivation is to avoid this whole block of comment entering the wrong section in the python parser.

---
 qapi/block-export.json | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
qapi/block-export.json +5 -5
index f183522d0d..1e34927f85 100644
@@ -219,13 +219,13 @@
 #
 # @hard: Drop all connections immediately and remove export.
 #
-# Potential additional modes to be added in the future:
+# TODO: Potential additional modes to be added in the future:
 #
-# hide: Just hide export from new clients, leave existing connections as is.
-# Remove export after all clients are disconnected.
+#       hide: Just hide export from new clients, leave existing connections as is.
+#       Remove export after all clients are disconnected.
 #
-# soft: Hide export from new clients, answer with ESHUTDOWN for all further
-# requests from existing clients.
+#       soft: Hide export from new clients, answer with ESHUTDOWN for all further
+#       requests from existing clients.
 #
 # Since: 2.12
 ##
Signature · 1 line
2.35.1
#2 lore raw

PATCH v2 2/14 qapi: fix example of BLOCK_IMAGE_CORRUPTED event

In reply to Victor Toso

Fatal is not optional.

---
 qapi/block-core.json | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
qapi/block-core.json +3 -4
index e89f2dfb5b..63c30a5378 100644
@@ -5006,10 +5006,9 @@
 # Example:
 #
 # <- { "event": "BLOCK_IMAGE_CORRUPTED",
-#      "data": { "device": "ide0-hd0", "node-name": "node0",
-#                "msg": "Prevented active L1 table overwrite", "offset": 196608,
-#                "size": 65536 },
-#      "timestamp": { "seconds": 1378126126, "microseconds": 966463 } }
+#      "data": { "device": "", "node-name": "drive", "fatal": false,
+#                "msg": "L2 table offset 0x2a2a2a00 unaligned (L1 index: 0)" },
+#      "timestamp": { "seconds": 1648243240, "microseconds": 906060 } }
 #
 # Since: 1.7
 ##
Signature · 1 line
2.35.1
#3 lore raw

Re: [PATCH v2 02/14] qapi: fix example of BLOCK_IMAGE_CORRUPTED event

Quoted 1 line · Victor Toso

Fatal is not optional.

Recognizing that "Fatal" refers to member "fatal" takes mental effort. Always use identifiers verbatim, including case. Where that makes for confusing prose, prefix with a @ like @fatal, or rephrase, like "The member fatal".

Quoted 14 lines
---
 qapi/block-core.json | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
qapi/block-core.json +0 -0
index e89f2dfb5b..63c30a5378 100644
@@ -5006,10 +5006,9 @@
 # Example:
 #
 # <- { "event": "BLOCK_IMAGE_CORRUPTED",

qapi/block-core.json line 5014

Quoted 10 lines
qapi/block-core.json +3 -4
-#      "data": { "device": "ide0-hd0", "node-name": "node0",
-#                "msg": "Prevented active L1 table overwrite", "offset": 196608,
-#                "size": 65536 },
-#      "timestamp": { "seconds": 1378126126, "microseconds": 966463 } }
+#      "data": { "device": "", "node-name": "drive", "fatal": false,
+#                "msg": "L2 table offset 0x2a2a2a00 unaligned (L1 index: 0)" },
+#      "timestamp": { "seconds": 1648243240, "microseconds": 906060 } }
 #
 # Since: 1.7
 ##

Changing the value of @msg makes sense, but is worth a note in the commit message.

Here's my try:

qapi: fix example of BLOCK_IMAGE_CORRUPTED event

Example output lacks mandatory member @fatal. Provide it.

Example output shows a value of @msg no version of the code produces. No big deal, but replace it anyway by one that today's code does produce.

How do you like it?

#4 lore raw

Re: [PATCH v2 02/14] qapi: fix example of BLOCK_IMAGE_CORRUPTED event

Hi,

Quoted 9 lines · Markus Armbruster
Quoted 1 line · Victor Toso

Fatal is not optional.

Recognizing that "Fatal" refers to member "fatal" takes mental effort. Always use identifiers verbatim, including case. Where that makes for confusing prose, prefix with a @ like @fatal, or rephrase, like "The
member fatal".

That's true.

Quoted 32 lines
Quoted 14 lines
---
 qapi/block-core.json | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
qapi/block-core.json +0 -0
index e89f2dfb5b..63c30a5378 100644
@@ -5006,10 +5006,9 @@
 # Example:
 #
 # <- { "event": "BLOCK_IMAGE_CORRUPTED",

qapi/block-core.json line 5014

Quoted 10 lines
qapi/block-core.json +3 -4
-#      "data": { "device": "ide0-hd0", "node-name": "node0",
-#                "msg": "Prevented active L1 table overwrite", "offset": 196608,
-#                "size": 65536 },
-#      "timestamp": { "seconds": 1378126126, "microseconds": 966463 } }
+#      "data": { "device": "", "node-name": "drive", "fatal": false,
+#                "msg": "L2 table offset 0x2a2a2a00 unaligned (L1 index: 0)" },
+#      "timestamp": { "seconds": 1648243240, "microseconds": 906060 } }
 #
 # Since: 1.7
 ##

Changing the value of @msg makes sense, but is worth a note in the commit message.

Here's my try:

qapi: fix example of BLOCK_IMAGE_CORRUPTED event

Quoted 7 lines

Example output lacks mandatory member @fatal. Provide it.

Example output shows a value of @msg no version of the code produces. No big deal, but replace it anyway by one that today's code does produce.

How do you like it?

I agree. I'll be more careful in near future. Thanks for the suggestion. I've submit a v2.1 of this patch.

Cheers,
Victor

#5 lore raw

Re: [PATCH v2 02/14] qapi: fix example of BLOCK_IMAGE_CORRUPTED event

Quoted 49 lines · Victor Toso

Hi,

Quoted 9 lines · Markus Armbruster
Quoted 1 line · Victor Toso

Fatal is not optional.

Recognizing that "Fatal" refers to member "fatal" takes mental effort. Always use identifiers verbatim, including case. Where that makes for confusing prose, prefix with a @ like @fatal, or rephrase, like "The
member fatal".

That's true.

Quoted 34 lines
Quoted 14 lines
---
 qapi/block-core.json | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
qapi/block-core.json +0 -0
index e89f2dfb5b..63c30a5378 100644
@@ -5006,10 +5006,9 @@
 # Example:
 #
 # <- { "event": "BLOCK_IMAGE_CORRUPTED",

qapi/block-core.json line 5014

Quoted 10 lines
qapi/block-core.json +3 -4
-#      "data": { "device": "ide0-hd0", "node-name": "node0",
-#                "msg": "Prevented active L1 table overwrite", "offset": 196608,
-#                "size": 65536 },
-#      "timestamp": { "seconds": 1378126126, "microseconds": 966463 } }
+#      "data": { "device": "", "node-name": "drive", "fatal": false,
+#                "msg": "L2 table offset 0x2a2a2a00 unaligned (L1 index: 0)" },
+#      "timestamp": { "seconds": 1648243240, "microseconds": 906060 } }
 #
 # Since: 1.7
 ##

Changing the value of @msg makes sense, but is worth a note in the commit message.

Here's my try:

qapi: fix example of BLOCK_IMAGE_CORRUPTED event

Example output lacks mandatory member @fatal. Provide it.

Quoted 8 lines
Quoted 5 lines

Example output shows a value of @msg no version of the code produces. No big deal, but replace it anyway by one that today's code does produce.

How do you like it?

I agree. I'll be more careful in near future. Thanks for the suggestion. I've submit a v2.1 of this patch.

That's okay. Asking me to replace the commit message in my tree is also okay.

PATCH 3's commit message could use the same treatment. Would you like to go over all of them and respin? Should be quick, no code changes.

Thanks!

#6 lore raw

Re: [PATCH v2 02/14] qapi: fix example of BLOCK_IMAGE_CORRUPTED event

Hi,

Quoted 60 lines · Markus Armbruster
Quoted 49 lines · Victor Toso

Hi,

Quoted 9 lines · Markus Armbruster
Quoted 1 line · Victor Toso

Fatal is not optional.

Recognizing that "Fatal" refers to member "fatal" takes mental effort. Always use identifiers verbatim, including case. Where that makes for confusing prose, prefix with a @ like @fatal, or rephrase, like "The
member fatal".

That's true.

Quoted 34 lines
Quoted 14 lines
---
 qapi/block-core.json | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
qapi/block-core.json +0 -0
index e89f2dfb5b..63c30a5378 100644
@@ -5006,10 +5006,9 @@
 # Example:
 #
 # <- { "event": "BLOCK_IMAGE_CORRUPTED",

qapi/block-core.json line 5014

Quoted 10 lines
qapi/block-core.json +3 -4
-#      "data": { "device": "ide0-hd0", "node-name": "node0",
-#                "msg": "Prevented active L1 table overwrite", "offset": 196608,
-#                "size": 65536 },
-#      "timestamp": { "seconds": 1378126126, "microseconds": 966463 } }
+#      "data": { "device": "", "node-name": "drive", "fatal": false,
+#                "msg": "L2 table offset 0x2a2a2a00 unaligned (L1 index: 0)" },
+#      "timestamp": { "seconds": 1648243240, "microseconds": 906060 } }
 #
 # Since: 1.7
 ##

Changing the value of @msg makes sense, but is worth a note in the commit message.

Here's my try:

qapi: fix example of BLOCK_IMAGE_CORRUPTED event

Example output lacks mandatory member @fatal. Provide it.

Quoted 8 lines
Quoted 5 lines

Example output shows a value of @msg no version of the code produces. No big deal, but replace it anyway by one that today's code does produce.

How do you like it?

I agree. I'll be more careful in near future. Thanks for the suggestion. I've submit a v2.1 of this patch.

Quoted 6 lines

That's okay. Asking me to replace the commit message in my tree is also okay.

PATCH 3's commit message could use the same treatment. Would you like to go over all of them and respin? Should be quick, no code changes.

Sure, I'll be sending a v3 and amend the commit messages where your previous suggestions fits. I'll add the changes in the cover-letter to help identify them.

Cheers,

#7 lore raw

PATCH 1/1 qapi: fix example of BLOCK_IMAGE_CORRUPTED event

In reply to Victor Toso

Example output lacks mandatory member @fatal. Provide it.

Example output shows a value of @msg no version of the code produces. No big deal, but replace it anyway by one that today's code does produce.

---
 qapi/block-core.json | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
qapi/block-core.json +3 -4
index e89f2dfb5b..63c30a5378 100644
@@ -5006,10 +5006,9 @@
 # Example:
 #
 # <- { "event": "BLOCK_IMAGE_CORRUPTED",
-#      "data": { "device": "ide0-hd0", "node-name": "node0",
-#                "msg": "Prevented active L1 table overwrite", "offset": 196608,
-#                "size": 65536 },
-#      "timestamp": { "seconds": 1378126126, "microseconds": 966463 } }
+#      "data": { "device": "", "node-name": "drive", "fatal": false,
+#                "msg": "L2 table offset 0x2a2a2a00 unaligned (L1 index: 0)" },
+#      "timestamp": { "seconds": 1648243240, "microseconds": 906060 } }
 #
 # Since: 1.7
 ##
Signature · 1 line
2.35.1
Reviewed-by on v1 1/1
#8 lore raw

Re: [PATCH v2.1] qapi: fix example of BLOCK_IMAGE_CORRUPTED event

Quoted 19 lines · Victor Toso

Example output lacks mandatory member @fatal. Provide it.

Example output shows a value of @msg no version of the code produces. No big deal, but replace it anyway by one that today's code does produce.

---
 qapi/block-core.json | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
qapi/block-core.json +0 -0
index e89f2dfb5b..63c30a5378 100644
@@ -5006,10 +5006,9 @@
 # Example:
 #
 # <- { "event": "BLOCK_IMAGE_CORRUPTED",

qapi/block-core.json line 5014

Quoted 10 lines
qapi/block-core.json +3 -4
-#      "data": { "device": "ide0-hd0", "node-name": "node0",
-#                "msg": "Prevented active L1 table overwrite", "offset": 196608,
-#                "size": 65536 },
-#      "timestamp": { "seconds": 1378126126, "microseconds": 966463 } }
+#      "data": { "device": "", "node-name": "drive", "fatal": false,
+#                "msg": "L2 table offset 0x2a2a2a00 unaligned (L1 index: 0)" },
+#      "timestamp": { "seconds": 1648243240, "microseconds": 906060 } }
 #
 # Since: 1.7
 ##
#9 lore raw

PATCH v2 3/14 qapi: fix example of BLOCK_IO_ERROR event

In reply to Victor Toso

Reason is not optional.

---
 qapi/block-core.json | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
qapi/block-core.json +2 -1
index 63c30a5378..46580ac551 100644
@@ -5058,7 +5058,8 @@
 #      "data": { "device": "ide0-hd1",
 #                "node-name": "#block212",
 #                "operation": "write",
-#                "action": "stop" },
+#                "action": "stop",
+#                "reason": "No space left on device" },
 #      "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
 #
 ##
Signature · 1 line
2.35.1
#10 lore raw

PATCH v2 4/14 qapi: fix example of BLOCK_JOB_PENDING event

In reply to Victor Toso

* Event's name: BLOCK_JOB_WAITING -> BLOCK_JOB_PENDING
* Argument device -> id

---
 qapi/block-core.json | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
qapi/block-core.json +2 -2
index 46580ac551..4a7a6940a3 100644
@@ -5225,8 +5225,8 @@
 #
 # Example:
 #
-# <- { "event": "BLOCK_JOB_WAITING",
-#      "data": { "device": "drive0", "type": "mirror" },
+# <- { "event": "BLOCK_JOB_PENDING",
+#      "data": { "type": "mirror", "id": "backup_1" },
 #      "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
 #
 ##
Signature · 1 line
2.35.1
#11 lore raw

PATCH v2 5/14 qapi: fix example of DUMP_COMPLETED event

In reply to Victor Toso

* Timestamp is not optional, let's add for completeness.
* Add '<-' to signalize it is receiving the data
* While at it, add extra space before "result" and "total" and after "completed" value.

---
 qapi/dump.json | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
qapi/dump.json +4 -3
index f7c4267e3f..9119c82b14 100644
@@ -161,9 +161,10 @@
 #
 # Example:
 #
-# { "event": "DUMP_COMPLETED",
-#   "data": {"result": {"total": 1090650112, "status": "completed",
-#                       "completed": 1090650112} } }
+# <- { "event": "DUMP_COMPLETED",
+#      "data": { "result": { "total": 1090650112, "status": "completed",
+#                            "completed": 1090650112 } },
+#      "timestamp": { "seconds": 1648244171, "microseconds": 950316 } }
 #
 ##
 { 'event': 'DUMP_COMPLETED' ,
Signature · 1 line
2.35.1
#12 lore raw

PATCH v2 6/14 qapi: fix example of MEMORY_DEVICE_SIZE_CHANGE event

In reply to Victor Toso

* qom-path is not optional

---
 qapi/machine.json | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
qapi/machine.json +2 -1
index 42fc68403d..9c460ec450 100644
@@ -1356,7 +1356,8 @@
 # Example:
 #
 # <- { "event": "MEMORY_DEVICE_SIZE_CHANGE",
-#      "data": { "id": "vm0", "size": 1073741824},
+#      "data": { "id": "vm0", "size": 1073741824,
+#                "qom-path": "/machine/unattached/device[2]" },
 #      "timestamp": { "seconds": 1588168529, "microseconds": 201316 } }
 #
 ##
Signature · 1 line
2.35.1
#13 lore raw

PATCH v2 7/14 qapi: fix example of UNPLUG_PRIMARY event

In reply to Victor Toso

* Timestamp is not optional, let's add for completeness.
* Add '<-' to signalize it is receiving the data
* Break lines like most of examples do

---
 qapi/migration.json | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
qapi/migration.json +3 -1
index 18e2610e88..092a63354b 100644
@@ -1736,7 +1736,9 @@
 # Since: 4.2
 #
 # Example:
-#   {"event": "UNPLUG_PRIMARY", "data": {"device-id": "hostdev0"} }
+# <- { "event": "UNPLUG_PRIMARY",
+#      "data": { "device-id": "hostdev0" },
+#      "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
 #
 ##
 { 'event': 'UNPLUG_PRIMARY',
Signature · 1 line
2.35.1
#14 lore raw

PATCH v2 8/14 qapi: fix example of FAILOVER_NEGOTIATED event

In reply to Victor Toso

* Data is an object, not a string. It generates a qdict.
* Timestamp is not optional, let's add for completeness.
* Add missing "@" to proper document "device-id"
* Add extra space for "Since" section

---
 qapi/net.json | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
qapi/net.json +4 -2
index 7fab2e7cd8..0d4578bd07 100644
@@ -685,13 +685,15 @@
 # Failover primary devices which were hidden (not hotplugged when requested)
 # before will now be hotplugged by the virtio-net standby device.
 #
-# device-id: QEMU device id of the unplugged device
+# @device-id: QEMU device id of the unplugged device
+#
 # Since: 4.2
 #
 # Example:
 #
 # <- { "event": "FAILOVER_NEGOTIATED",
-#      "data": "net1" }
+#      "data": { "device-id": "net1" },
+#      "timestamp": { "seconds": 1368697518, "microseconds": 326866 } }
 #
 ##
 { 'event': 'FAILOVER_NEGOTIATED',
Signature · 1 line
2.35.1
#15 lore raw

PATCH v2 9/14 qapi: fix examples: SHUTDOWN and RESET events

In reply to Victor Toso

The 'reason' member in not optional.

---
 qapi/run-state.json | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
qapi/run-state.json +4 -2
index 43d66d700f..1b9f64c9cd 100644
@@ -150,7 +150,8 @@
 #
 # Example:
 #
-# <- { "event": "SHUTDOWN", "data": { "guest": true },
+# <- { "event": "SHUTDOWN",
+#      "data": { "guest": true, "reason": "guest-shutdown" },
 #      "timestamp": { "seconds": 1267040730, "microseconds": 682951 } }
 #
 ##
@@ -188,7 +189,8 @@
 #
 # Example:
 #
-# <- { "event": "RESET", "data": { "guest": false },
+# <- { "event": "RESET",
+#      "data": { "guest": false, "reason": "guest-reset" },
 #      "timestamp": { "seconds": 1267041653, "microseconds": 9518 } }
 #
 ##
Signature · 1 line
2.35.1
#16 lore raw

PATCH v2 10/14 qapi: run-state examples: add missing timestamp

In reply to Victor Toso
---
 qapi/run-state.json | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
qapi/run-state.json +4 -2
index 1b9f64c9cd..7f1c788c4e 100644
@@ -426,7 +426,8 @@
 # Example:
 #
 # <- { "event": "GUEST_PANICKED",
-#      "data": { "action": "pause" } }
+#      "data": { "action": "pause" },
+#      "timestamp": { "seconds": 1648245231, "microseconds": 900001 } }
 #
 ##
 { 'event': 'GUEST_PANICKED',
@@ -446,7 +447,8 @@
 # Example:
 #
 # <- { "event": "GUEST_CRASHLOADED",
-#      "data": { "action": "run" } }
+#      "data": { "action": "run" },
+#      "timestamp": { "seconds": 1648245259, "microseconds": 893771 } }
 #
 ##
 { 'event': 'GUEST_CRASHLOADED',
Signature · 1 line
2.35.1
#17 lore raw

PATCH v2 11/14 qapi: fix example of MEMORY_FAILURE

In reply to Victor Toso

Minor issues found and fixed with the example:
* The JSON object of EVENT was not closed
* Missing timestamp
* Flags are optional but if defined then all members should be include so we add "recursive" member.
* Changed string from '' to "" in action-required member.

---
 qapi/run-state.json | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
qapi/run-state.json +3 -1
index 7f1c788c4e..8124220bd9 100644
@@ -571,7 +571,9 @@
 # <- { "event": "MEMORY_FAILURE",
 #      "data": { "recipient": "hypervisor",
 #                "action": "fatal",
-#                "flags": { 'action-required': false } }
+#                "flags": { "action-required": false,
+#                           "recursive": false } },
+#      "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
 #
 ##
 { 'event': 'MEMORY_FAILURE',
Signature · 1 line
2.35.1
#18 lore raw

PATCH v2 12/14 qapi: ui examples: add missing websocket member

In reply to Victor Toso

As the websocket is not optional in VncBasicInfo.

---
 qapi/ui.json | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
qapi/ui.json +6 -6
index 664da9e462..a810ed680c 100644
@@ -710,10 +710,10 @@
 #
 # <- { "event": "VNC_CONNECTED",
 #      "data": {
-#            "server": { "auth": "sasl", "family": "ipv4",
+#            "server": { "auth": "sasl", "family": "ipv4", "websocket": false,
 #                        "service": "5901", "host": "0.0.0.0" },
 #            "client": { "family": "ipv4", "service": "58425",
-#                        "host": "127.0.0.1" } },
+#                        "host": "127.0.0.1", "websocket": false } },
 #      "timestamp": { "seconds": 1262976601, "microseconds": 975795 } }
 #
 ##
@@ -738,9 +738,9 @@
 #
 # <-  { "event": "VNC_INITIALIZED",
 #       "data": {
-#            "server": { "auth": "sasl", "family": "ipv4",
+#            "server": { "auth": "sasl", "family": "ipv4", "websocket": false,
 #                        "service": "5901", "host": "0.0.0.0"},
-#            "client": { "family": "ipv4", "service": "46089",
+#            "client": { "family": "ipv4", "service": "46089", "websocket": false,
 #                        "host": "127.0.0.1", "sasl_username": "luiz" } },
 #       "timestamp": { "seconds": 1263475302, "microseconds": 150772 } }
 #
@@ -765,9 +765,9 @@
 #
 # <- { "event": "VNC_DISCONNECTED",
 #      "data": {
-#            "server": { "auth": "sasl", "family": "ipv4",
+#            "server": { "auth": "sasl", "family": "ipv4", "websocket": false,
 #                        "service": "5901", "host": "0.0.0.0" },
-#            "client": { "family": "ipv4", "service": "58425",
+#            "client": { "family": "ipv4", "service": "58425", "websocket": false,
 #                        "host": "127.0.0.1", "sasl_username": "luiz" } },
 #      "timestamp": { "seconds": 1262976601, "microseconds": 975795 } }
 #
Signature · 1 line
2.35.1
#19 lore raw

PATCH v2 13/14 qapi: fix example of ACPI_DEVICE_OST event

In reply to Victor Toso

* Missing the timestamp
* Missing the "info" object in the "data" member

---
 qapi/acpi.json | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
qapi/acpi.json +3 -2
index 51f0d55db7..d148f6db9f 100644
@@ -133,8 +133,9 @@
 # Example:
 #
 # <- { "event": "ACPI_DEVICE_OST",
-#      "data": { "device": "d1", "slot": "0",
-#                "slot-type": "DIMM", "source": 1, "status": 0 } }
+#      "data": { "info": { "device": "d1", "slot": "0",
+#                          "slot-type": "DIMM", "source": 1, "status": 0 } },
+#      "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
 #
 ##
 { 'event': 'ACPI_DEVICE_OST',
Signature · 1 line
2.35.1
#20 lore raw

PATCH v2 14/14 qapi: fix example of dump-guest-memory

In reply to Victor Toso

The member "paging" is not optional

---
 qapi/dump.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
qapi/dump.json +1 -1
index 9119c82b14..29441af9d8 100644
@@ -83,7 +83,7 @@
 # Example:
 #
 # -> { "execute": "dump-guest-memory",
-#      "arguments": { "protocol": "fd:dump" } }
+#      "arguments": { "paging": false, "protocol": "fd:dump" } }
 # <- { "return": {} }
 #
 ##
Signature · 1 line
2.35.1