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/pragma.json | 3 +++ qapi/run-state.json | 16 +++++++++++----- qapi/ui.json | 12 ++++++------ 10 files changed, 49 insertions(+), 33 deletions(-)
I double-checked these patches affect *only* generated documentation.
Safe enough for 7.0, I think. But I'm quite content to hold on to
them until after the release, if that's preferred.
The following changes since commit aea6e471085f39ada1ccd637043c3ee3dfd88750:
Update version for v7.0.0-rc2 release (2022-03-29 23:32:18 +0100)
are available in the Git repository at:
git://repo.or.cz/qemu/armbru.git tags/pull-qapi-2022-03-31
for you to fetch changes up to 4375cf9868fbb7abcaae119ac993b13f72dfe8f2:
qapi: fix example of dump-guest-memory (2022-03-31 12:35:59 +0200)
----------------------------------------------------------------
QAPI patches patches for 2022-03-31
----------------------------------------------------------------
Victor Toso (15):
schemas: add missing vim modeline
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/pragma.json | 3 +++
qapi/run-state.json | 16 +++++++++++-----
qapi/ui.json | 12 ++++++------
10 files changed, 49 insertions(+), 33 deletions(-)
--
2.35.1
On Thu, 31 Mar 2022 at 11:54, Markus Armbruster <armbru@redhat.com> wrote: > > I double-checked these patches affect *only* generated documentation. > Safe enough for 7.0, I think. But I'm quite content to hold on to > them until after the release, if that's preferred. > > The following changes since commit aea6e471085f39ada1ccd637043c3ee3dfd88750: > > Update version for v7.0.0-rc2 release (2022-03-29 23:32:18 +0100) > > are available in the Git repository at: > > git://repo.or.cz/qemu/armbru.git tags/pull-qapi-2022-03-31 > > for you to fetch changes up to 4375cf9868fbb7abcaae119ac993b13f72dfe8f2: > > qapi: fix example of dump-guest-memory (2022-03-31 12:35:59 +0200) > > ---------------------------------------------------------------- > QAPI patches patches for 2022-03-31 > Docs-only changes seem fine to me at this point. Applied, thanks. Please update the changelog at https://wiki.qemu.org/ChangeLog/7.0 for any user-visible changes. -- PMM
From: Victor Toso <victortoso@redhat.com>
This is the last qapi schema that is missing the modeline.
Fixes 7e7237cd2b "schemas: add missing vim modeline"
Signed-off-by: Victor Toso <victortoso@redhat.com>
Message-Id: <20220325221605.53995-1-victortoso@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/pragma.json | 3 +++
1 file changed, 3 insertions(+)
diff --git a/qapi/pragma.json b/qapi/pragma.json
index 3bc0335d1f..e6a021c19c 100644
--- a/qapi/pragma.json
+++ b/qapi/pragma.json
@@ -1,3 +1,6 @@
+# -*- Mode: Python -*-
+# vim: filetype=python
+
{ 'pragma': { 'doc-required': true } }
# Whitelists to permit QAPI rule violations; think twice before you
--
2.35.1
From: Victor Toso <victortoso@redhat.com> @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. Signed-off-by: Victor Toso <victortoso@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: John Snow <jsnow@redhat.com> Message-Id: <20220328140604.41484-2-victortoso@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com> --- qapi/block-export.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/qapi/block-export.json b/qapi/block-export.json index f183522d0d..1e34927f85 100644 --- a/qapi/block-export.json +++ b/qapi/block-export.json @@ -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 ## -- 2.35.1
From: Victor Toso <victortoso@redhat.com>
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 <victortoso@redhat.com>
Message-Id: <20220328140604.41484-3-victortoso@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/block-core.json | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index e89f2dfb5b..63c30a5378 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -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
##
--
2.35.1
From: Victor Toso <victortoso@redhat.com>
Example output lacks mandatory member @reason. Provide it.
Signed-off-by: Victor Toso <victortoso@redhat.com>
Message-Id: <20220328140604.41484-4-victortoso@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/block-core.json | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 63c30a5378..46580ac551 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -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 } }
#
##
--
2.35.1
From: Victor Toso <victortoso@redhat.com>
Example output has the wrong event's name in it. Fix it.
Example output shows incorrect member @device. Fix it.
Signed-off-by: Victor Toso <victortoso@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20220328140604.41484-5-victortoso@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/block-core.json | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 46580ac551..4a7a6940a3 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -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 } }
#
##
--
2.35.1
From: Victor Toso <victortoso@redhat.com>
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;
- Adding extra spaces around members @result, @total and @completed
Signed-off-by: Victor Toso <victortoso@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Message-Id: <20220328140604.41484-6-victortoso@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/dump.json | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/qapi/dump.json b/qapi/dump.json
index f7c4267e3f..9119c82b14 100644
--- a/qapi/dump.json
+++ b/qapi/dump.json
@@ -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' ,
--
2.35.1
From: Victor Toso <victortoso@redhat.com>
Example output lacks mandatory member @qom-path. Provide it.
Signed-off-by: Victor Toso <victortoso@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20220328140604.41484-7-victortoso@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/machine.json | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/qapi/machine.json b/qapi/machine.json
index 42fc68403d..9c460ec450 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -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 } }
#
##
--
2.35.1
From: Victor Toso <victortoso@redhat.com>
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 <victortoso@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Message-Id: <20220328140604.41484-8-victortoso@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/migration.json | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/qapi/migration.json b/qapi/migration.json
index 18e2610e88..092a63354b 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -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',
--
2.35.1
From: Victor Toso <victortoso@redhat.com>
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" section
Signed-off-by: Victor Toso <victortoso@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Message-Id: <20220328140604.41484-9-victortoso@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/net.json | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/qapi/net.json b/qapi/net.json
index 7fab2e7cd8..0d4578bd07 100644
--- a/qapi/net.json
+++ b/qapi/net.json
@@ -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',
--
2.35.1
From: Victor Toso <victortoso@redhat.com>
Example output lacks mandatory member @reason. Provide it.
Signed-off-by: Victor Toso <victortoso@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Message-Id: <20220328140604.41484-10-victortoso@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/run-state.json | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/qapi/run-state.json b/qapi/run-state.json
index 43d66d700f..1b9f64c9cd 100644
--- a/qapi/run-state.json
+++ b/qapi/run-state.json
@@ -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 } }
#
##
--
2.35.1
From: Victor Toso <victortoso@redhat.com>
The changed examples were lacking mandatory member @timestamp.
Provide it.
Signed-off-by: Victor Toso <victortoso@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Message-Id: <20220328140604.41484-11-victortoso@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/run-state.json | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/qapi/run-state.json b/qapi/run-state.json
index 1b9f64c9cd..7f1c788c4e 100644
--- a/qapi/run-state.json
+++ b/qapi/run-state.json
@@ -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',
--
2.35.1
From: Victor Toso <victortoso@redhat.com>
Example output lacks mandatory member @timestamp. Provide it.
Example output lacks mandatory member flags.recursive. Provide it.
Minor: Change quotes from '' to "" in @action-required member.
Signed-off-by: Victor Toso <victortoso@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Message-Id: <20220328140604.41484-12-victortoso@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Commit message fixed up]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/run-state.json | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/qapi/run-state.json b/qapi/run-state.json
index 7f1c788c4e..8124220bd9 100644
--- a/qapi/run-state.json
+++ b/qapi/run-state.json
@@ -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',
--
2.35.1
From: Victor Toso <victortoso@redhat.com>
The examples were missing mandatory member @websocket. Provide it.
Signed-off-by: Victor Toso <victortoso@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Message-Id: <20220328140604.41484-13-victortoso@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/ui.json | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/qapi/ui.json b/qapi/ui.json
index 664da9e462..a810ed680c 100644
--- a/qapi/ui.json
+++ b/qapi/ui.json
@@ -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 } }
#
--
2.35.1
From: Victor Toso <victortoso@redhat.com>
Example output lacks mandatory member @timestamp. Provide it.
Event's @data member is missing @info object. Provide it.
Signed-off-by: Victor Toso <victortoso@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Message-Id: <20220328140604.41484-14-victortoso@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/acpi.json | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/qapi/acpi.json b/qapi/acpi.json
index 51f0d55db7..d148f6db9f 100644
--- a/qapi/acpi.json
+++ b/qapi/acpi.json
@@ -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',
--
2.35.1
From: Victor Toso <victortoso@redhat.com>
Example output lacks mandatory member @paging. Provide it.
Signed-off-by: Victor Toso <victortoso@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Message-Id: <20220328140604.41484-15-victortoso@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/dump.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/qapi/dump.json b/qapi/dump.json
index 9119c82b14..29441af9d8 100644
--- a/qapi/dump.json
+++ b/qapi/dump.json
@@ -83,7 +83,7 @@
# Example:
#
# -> { "execute": "dump-guest-memory",
-# "arguments": { "protocol": "fd:dump" } }
+# "arguments": { "paging": false, "protocol": "fd:dump" } }
# <- { "return": {} }
#
##
--
2.35.1
© 2016 - 2026 Red Hat, Inc.