Fix some qapi examples and a TODO section
v3 cover Fix some qapi examples and a TODO section
Hi,
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 v3:
Improved commit log from patch 03 to 14 with suggetions based on:
https://lists.gnu.org/archive/html/qemu-devel/2022-03/msg06490.html
* 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
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
PATCH v3 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
@@ -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
PATCH v3 2/14 qapi: fix example of BLOCK_IMAGE_CORRUPTED event
In reply to Victor TosoExample 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
@@ -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
Re: [PATCH v3 02/14] 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.
Signed-off-by Victor Toso <[email protected]>--- qapi/block-core.json | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)qapi/block-core.json +0
-0@@ -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 ##
PATCH v3 3/14 qapi: fix example of BLOCK_IO_ERROR event
In reply to Victor TosoExample output lacks mandatory member @reason. Provide it.
--- qapi/block-core.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
qapi/block-core.json +2 -1
@@ -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
Re: [PATCH v3 03/14] qapi: fix example of BLOCK_IO_ERROR event
Quoted 12 lines · Victor Toso
Example output lacks mandatory member @reason. Provide it.
Signed-off-by Victor Toso <[email protected]>--- qapi/block-core.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)qapi/block-core.json +0
-0
qapi/block-core.json line 5065
Quoted 9 lines
qapi/block-core.json +2
-1@@ -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 } } # ##
I briefly wondered whether "reason": "No space left on device" implies "nospace: true, but it looks like it doesn't.
PATCH v3 4/14 qapi: fix example of BLOCK_JOB_PENDING event
In reply to Victor TosoExample output has the wrong event's name in it. Fix it.
Example output shows incorrect member @device. Fix it.
--- qapi/block-core.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
qapi/block-core.json +2 -2
@@ -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
PATCH v3 5/14 qapi: fix example of DUMP_COMPLETED event
In reply to Victor TosoExample output lacks mandatory member @timestamp. Provide it.
Example output is not properly formatted. Fixing it by:
- Adding '<-' to signalize it is receiving the data;
- Adding extra spaces around members @result, @total and @completed
--- qapi/dump.json | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
qapi/dump.json +4 -3
@@ -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
PATCH v3 6/14 qapi: fix example of MEMORY_DEVICE_SIZE_CHANGE event
In reply to Victor TosoExample output lacks mandatory member @qom-path. Provide it.
--- qapi/machine.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
qapi/machine.json +2 -1
@@ -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
PATCH v3 7/14 qapi: fix example of UNPLUG_PRIMARY event
In reply to Victor TosoExample output lacks mandatory member @timestamp. Provide it.
Example output is not properly formatted. Fixing it by:
- Adding '<-' to signalize it is receiving the data;
- Breaking lines similar to the other examples.
--- qapi/migration.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
qapi/migration.json +3 -1
@@ -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
Re: [PATCH v3 07/14] qapi: fix example of UNPLUG_PRIMARY event
Quoted 17 lines · Victor Toso
Example output lacks mandatory member @timestamp. Provide it.
Example output is not properly formatted. Fixing it by:
- Adding '<-' to signalize it is receiving the data;
- Breaking lines similar to the other examples.Signed-off-by Victor Toso <[email protected]>Reviewed-by John Snow <[email protected]>--- qapi/migration.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)qapi/migration.json +0
-0
qapi/migration.json line 1744
Quoted 10 lines
qapi/migration.json +3
-1@@ -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',
PATCH v3 8/14 qapi: fix example of FAILOVER_NEGOTIATED event
In reply to Victor TosoExample output lacks mandatory member @timestamp. Provide it.
Event's documentation is not properly formatted. Fix it by:
- Adding @ to "device-id"
- Adding extra line for "Since" section
--- qapi/net.json | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
qapi/net.json +4 -2
@@ -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
Re: [PATCH v3 08/14] qapi: fix example of FAILOVER_NEGOTIATED event
Quoted 24 lines · Victor Toso
Example output lacks mandatory member @timestamp. Provide it.
Event's documentation is not properly formatted. Fix it by:
- Adding @ to "device-id"
- Adding extra line for "Since" sectionSigned-off-by Victor Toso <[email protected]>Reviewed-by John Snow <[email protected]>--- qapi/net.json | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)qapi/net.json +2
-1@@ -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
qapi/net.json line 699
Quoted 10 lines
qapi/net.json +2
-1# # Example: # # <- { "event": "FAILOVER_NEGOTIATED", -# "data": "net1" } +# "data": { "device-id": "net1" }, +# "timestamp": { "seconds": 1368697518, "microseconds": 326866 } } # ## { 'event': 'FAILOVER_NEGOTIATED',
PATCH v3 9/14 qapi: fix examples: SHUTDOWN and RESET events
In reply to Victor TosoExample output lacks mandatory member @reason. Provide it.
--- qapi/run-state.json | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
qapi/run-state.json +4 -2
@@ -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
Re: [PATCH v3 09/14] qapi: fix examples: SHUTDOWN and RESET events
Quoted 23 lines · Victor Toso
Example output lacks mandatory member @reason. Provide it.
Signed-off-by Victor Toso <[email protected]>Reviewed-by John Snow <[email protected]>--- qapi/run-state.json | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)qapi/run-state.json +2
-1@@ -150,7 +150,8 @@ # # Example: # -# <- { "event": "SHUTDOWN", "data": { "guest": true }, +# <- { "event": "SHUTDOWN", +# "data": { "guest": true, "reason": "guest-shutdown" }, # "timestamp": { "seconds": 1267040730, "microseconds": 682951 } } # ##
qapi/run-state.json line 196
Quoted 9 lines
qapi/run-state.json +2
-1@@ -188,7 +189,8 @@ # # Example: # -# <- { "event": "RESET", "data": { "guest": false }, +# <- { "event": "RESET", +# "data": { "guest": false, "reason": "guest-reset" }, # "timestamp": { "seconds": 1267041653, "microseconds": 9518 } } # ##
PATCH v3 10/14 qapi: run-state examples: add missing @timestamp
In reply to Victor TosoThe changed examples were lacking mandatory member @timestamp. Provide it.
--- qapi/run-state.json | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
qapi/run-state.json +4 -2
@@ -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
Re: [PATCH v3 10/14] qapi: run-state examples: add missing @timestamp
Quoted 24 lines · Victor Toso
The changed examples were lacking mandatory member @timestamp. Provide it.
Signed-off-by Victor Toso <[email protected]>Reviewed-by John Snow <[email protected]>--- qapi/run-state.json | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)qapi/run-state.json +2
-1@@ -426,7 +426,8 @@ # Example: # # <- { "event": "GUEST_PANICKED", -# "data": { "action": "pause" } } +# "data": { "action": "pause" }, +# "timestamp": { "seconds": 1648245231, "microseconds": 900001 } } # ## { 'event': 'GUEST_PANICKED',
qapi/run-state.json line 454
Quoted 9 lines
qapi/run-state.json +2
-1@@ -446,7 +447,8 @@ # Example: # # <- { "event": "GUEST_CRASHLOADED", -# "data": { "action": "run" } } +# "data": { "action": "run" }, +# "timestamp": { "seconds": 1648245259, "microseconds": 893771 } } # ## { 'event': 'GUEST_CRASHLOADED',
PATCH v3 11/14 qapi: fix example of MEMORY_FAILURE
In reply to Victor TosoExample output lacks mandatory member @timestamp. Provide it.
While @flags is an optional member, if it is defined then all its members should be include. For that reason, we add @recursive member.
Minor: Change quotes from '' to "" in @action-required member.
--- qapi/run-state.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
qapi/run-state.json +3 -1
@@ -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
Re: [PATCH v3 11/14] qapi: fix example of MEMORY_FAILURE
Quoted 3 lines · Victor Toso
Example output lacks mandatory member @timestamp. Provide it.
While @flags is an optional member,
Uh, it isn't.
Quoted 2 lines
if it is defined then all its
members should be include. For that reason, we add @recursive member.
Perhaps:
Example output lacks mandatory member flags.recursive. Provide it.
Happy to make such a change in my tree.
Quoted 13 lines
Minor: Change quotes from '' to "" in @action-required member.
Signed-off-by Victor Toso <[email protected]>Reviewed-by John Snow <[email protected]>--- qapi/run-state.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)qapi/run-state.json +0
-0
qapi/run-state.json line 579
Quoted 10 lines
qapi/run-state.json +3
-1@@ -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',
With the commit message fixed:
Re: [PATCH v3 11/14] qapi: fix example of MEMORY_FAILURE
Hi,
Quoted 7 lines · Markus Armbruster
Quoted 3 lines · Victor Toso
Example output lacks mandatory member @timestamp. Provide it.
While @flags is an optional member,
Uh, it isn't.
Wow! I was so sure I saw "*flags" before. Nice catch.
Quoted 8 lines
Quoted 2 lines
if it is defined then all its
members should be include. For that reason, we add @recursive member.Perhaps:
Example output lacks mandatory member flags.recursive. Provide it.
Happy to make such a change in my tree.
Yes, many thanks!
Quoted 25 lines
Quoted 13 lines
Minor: Change quotes from '' to "" in @action-required member.
Signed-off-by Victor Toso <[email protected]>Reviewed-by John Snow <[email protected]>--- qapi/run-state.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)qapi/run-state.json +0
-0qapi/run-state.json line 579
Quoted 10 lines
qapi/run-state.json +3
-1@@ -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',With the commit message fixed:
Quoted 1 line
Reviewed-by Markus Armbruster <[email protected]>
Cheers,
Victor
PATCH v3 12/14 qapi: ui examples: add missing @websocket member
In reply to Victor TosoThe examples were missing mandatory member @websocket. Provide it.
--- qapi/ui.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)
qapi/ui.json +6 -6
@@ -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
Re: [PATCH v3 12/14] qapi: ui examples: add missing @websocket member
Quoted 39 lines · Victor Toso
The examples were missing mandatory member @websocket. Provide it.
Signed-off-by Victor Toso <[email protected]>Reviewed-by John Snow <[email protected]>--- qapi/ui.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)qapi/ui.json +4
-4@@ -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 @@ #
qapi/ui.json line 773
Quoted 10 lines
qapi/ui.json +2
-2# <- { "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 } } #
PATCH v3 13/14 qapi: fix example of ACPI_DEVICE_OST event
In reply to Victor TosoExample output lacks mandatory member @timestamp. Provide it.
Event's @data member is missing @info object. Provide it.
--- qapi/acpi.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
qapi/acpi.json +3 -2
@@ -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
Re: [PATCH v3 13/14] qapi: fix example of ACPI_DEVICE_OST event
Quoted 16 lines · Victor Toso
Example output lacks mandatory member @timestamp. Provide it.
Event's @data member is missing @info object. Provide it.
Signed-off-by Victor Toso <[email protected]>Reviewed-by John Snow <[email protected]>--- qapi/acpi.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)qapi/acpi.json +0
-0@@ -133,8 +133,9 @@ # Example:
qapi/acpi.json line 141
Quoted 10 lines
qapi/acpi.json +3
-2# # <- { "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',
PATCH v3 14/14 qapi: fix example of dump-guest-memory
In reply to Victor TosoExample output lacks mandatory member @paging. Provide it.
--- qapi/dump.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
qapi/dump.json +1 -1
@@ -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
Re: [PATCH v3 14/14] qapi: fix example of dump-guest-memory
Quoted 13 lines · Victor Toso
Example output lacks mandatory member @paging. Provide it.
Signed-off-by Victor Toso <[email protected]>Reviewed-by John Snow <[email protected]>--- qapi/dump.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)qapi/dump.json +0
-0
qapi/dump.json line 89
Quoted 8 lines
qapi/dump.json +1
-1@@ -83,7 +83,7 @@ # Example: # # -> { "execute": "dump-guest-memory", -# "arguments": { "protocol": "fd:dump" } } +# "arguments": { "paging": false, "protocol": "fd:dump" } } # <- { "return": {} } # ##
Quoted 6 lines · Victor Toso
Hi,
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.
Lovely doc fixes. I want them all. Thanks!
John Snow
Reviewed-byQuoted 12 lines · Markus Armbruster
Quoted 6 lines · Victor Toso
Hi,
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.
Lovely doc fixes. I want them all. Thanks!
Seconded.
Thanks!
Quoted 6 lines · Victor Toso
Hi,
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.
All queued, thanks!