[PATCH v1 0/9] Fix some qapi examples

[PATCH v1 0/9] Fix some qapi examples

[Victor Toso]

Hi,

I did another iteration of adding the examples in the qapi documentation
as unit tests in another project and found a few that could be updated.

Feel free to cherry-pick them. Happy to rework it if needed.

Victor Toso (9):
  qapi: fix example of netdev_add command
  qapi: fix examples: replay-break and replay-seek
  qapi: fix example of query-named-block-nodes command
  qapi: fix example of query-spice command
  qapi: fix example of query-vnc command
  qapi: fix example of query-colo-status command
  qapi: fix example of trace-event-get-state command
  qapi: fix example of query-cpus-fast command
  qapi: fix example of query-memdev command

 qapi/block-core.json | 1 +
 qapi/machine.json    | 4 ++--
 qapi/migration.json  | 2 +-
 qapi/net.json        | 2 +-
 qapi/replay.json     | 4 ++--
 qapi/trace.json      | 2 +-
 qapi/ui.json         | 3 +++
 7 files changed, 11 insertions(+), 7 deletions(-)

-- 
2.35.1

[PATCH v1 1/9] qapi: fix example of netdev_add command

[Victor Toso]

Example output has the optional member @dnssearch as string type. It
should be an array of strings instead. Fix it.

For reference, see NetdevUserOptions.

Signed-off-by: Victor Toso <victortoso@redhat.com>
---
 qapi/net.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/qapi/net.json b/qapi/net.json
index 0d4578bd07..efc0bae170 100644
--- a/qapi/net.json
+++ b/qapi/net.json
@@ -51,7 +51,7 @@
 #
 # -> { "execute": "netdev_add",
 #      "arguments": { "type": "user", "id": "netdev1",
-#                     "dnssearch": "example.org" } }
+#                     "dnssearch": [ "example.org" ] } }
 # <- { "return": {} }
 #
 ##
-- 
2.35.1

Re: [PATCH v1 1/9] qapi: fix example of netdev_add command

[Markus Armbruster]

Victor Toso <victortoso@redhat.com> writes:

> Example output has the optional member @dnssearch as string type. It
> should be an array of strings instead. Fix it.
>
> For reference, see NetdevUserOptions.
>
> Signed-off-by: Victor Toso <victortoso@redhat.com>
> ---
>  qapi/net.json | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/qapi/net.json b/qapi/net.json
> index 0d4578bd07..efc0bae170 100644
> --- a/qapi/net.json
> +++ b/qapi/net.json
> @@ -51,7 +51,7 @@
>  #
>  # -> { "execute": "netdev_add",
>  #      "arguments": { "type": "user", "id": "netdev1",
> -#                     "dnssearch": "example.org" } }
> +#                     "dnssearch": [ "example.org" ] } }
>  # <- { "return": {} }
>  #
>  ##

Uh, @dnssearch is ['String']...  shouldn't this be something like

   #                     "dnssearch": [ { "str": "example.org" } ] } }

?

Re: [PATCH v1 1/9] qapi: fix example of netdev_add command

[Victor Toso]

[-- Attachment #1: Type: text/plain, Size: 1146 bytes --]

Hi,

On Fri, Apr 01, 2022 at 09:56:40AM +0200, Markus Armbruster wrote:
> Victor Toso <victortoso@redhat.com> writes:
> 
> > Example output has the optional member @dnssearch as string type. It
> > should be an array of strings instead. Fix it.
> >
> > For reference, see NetdevUserOptions.
> >
> > Signed-off-by: Victor Toso <victortoso@redhat.com>
> > ---
> >  qapi/net.json | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/qapi/net.json b/qapi/net.json
> > index 0d4578bd07..efc0bae170 100644
> > --- a/qapi/net.json
> > +++ b/qapi/net.json
> > @@ -51,7 +51,7 @@
> >  #
> >  # -> { "execute": "netdev_add",
> >  #      "arguments": { "type": "user", "id": "netdev1",
> > -#                     "dnssearch": "example.org" } }
> > +#                     "dnssearch": [ "example.org" ] } }
> >  # <- { "return": {} }
> >  #
> >  ##
> 
> Uh, @dnssearch is ['String']...  shouldn't this be something like
> 
>    #                     "dnssearch": [ { "str": "example.org" } ] } }
> 
> ?

Yes, my mistake. Thanks for spotting it.
I'll resend this patch shortly.

Cheers,
Victor

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

[PATCH v1.1 1/9] qapi: fix example of netdev_add command

[Victor Toso]

Example output has the optional member @dnssearch as string type. It
should be an array of strings instead. Fix it.

For reference, see NetdevUserOptions.

Signed-off-by: Victor Toso <victortoso@redhat.com>
---
 qapi/net.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/qapi/net.json b/qapi/net.json
index 0d4578bd07..b92f3f5fb4 100644
--- a/qapi/net.json
+++ b/qapi/net.json
@@ -51,7 +51,7 @@
 #
 # -> { "execute": "netdev_add",
 #      "arguments": { "type": "user", "id": "netdev1",
-#                     "dnssearch": "example.org" } }
+#                     "dnssearch": [ { "str": "example.org" } ] } }
 # <- { "return": {} }
 #
 ##
-- 
2.35.1

Re: [PATCH v1.1 1/9] qapi: fix example of netdev_add command

[Markus Armbruster]

Victor Toso <victortoso@redhat.com> writes:

> Example output has the optional member @dnssearch as string type. It
> should be an array of strings instead. Fix it.

"of String objects".  Happy to fix this in my tree.

>
> For reference, see NetdevUserOptions.
>
> Signed-off-by: Victor Toso <victortoso@redhat.com>
> ---
>  qapi/net.json | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/qapi/net.json b/qapi/net.json
> index 0d4578bd07..b92f3f5fb4 100644
> --- a/qapi/net.json
> +++ b/qapi/net.json
> @@ -51,7 +51,7 @@
>  #
>  # -> { "execute": "netdev_add",
>  #      "arguments": { "type": "user", "id": "netdev1",
> -#                     "dnssearch": "example.org" } }
> +#                     "dnssearch": [ { "str": "example.org" } ] } }
>  # <- { "return": {} }
>  #
>  ##

Preferably with the commit message tweak:
Reviewed-by: Markus Armbruster <armbru@redhat.com>

Re: [PATCH v1.1 1/9] qapi: fix example of netdev_add command

[Victor Toso]

[-- Attachment #1: Type: text/plain, Size: 1096 bytes --]

Hi,

On Mon, Apr 04, 2022 at 08:14:11AM +0200, Markus Armbruster wrote:
> Victor Toso <victortoso@redhat.com> writes:
> 
> > Example output has the optional member @dnssearch as string type. It
> > should be an array of strings instead. Fix it.
> 
> "of String objects".  Happy to fix this in my tree.

Sure

> 
> >
> > For reference, see NetdevUserOptions.
> >
> > Signed-off-by: Victor Toso <victortoso@redhat.com>
> > ---
> >  qapi/net.json | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/qapi/net.json b/qapi/net.json
> > index 0d4578bd07..b92f3f5fb4 100644
> > --- a/qapi/net.json
> > +++ b/qapi/net.json
> > @@ -51,7 +51,7 @@
> >  #
> >  # -> { "execute": "netdev_add",
> >  #      "arguments": { "type": "user", "id": "netdev1",
> > -#                     "dnssearch": "example.org" } }
> > +#                     "dnssearch": [ { "str": "example.org" } ] } }
> >  # <- { "return": {} }
> >  #
> >  ##
> 
> Preferably with the commit message tweak:
> Reviewed-by: Markus Armbruster <armbru@redhat.com>

Thanks,
Victor

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

[PATCH v1 2/9] qapi: fix examples: replay-break and replay-seek

[Victor Toso]

Both examples outputs are using @data member for the arguments. This
is wrong. The expected member for the QMP is @arguments. Fix it.

Signed-off-by: Victor Toso <victortoso@redhat.com>
---
 qapi/replay.json | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/qapi/replay.json b/qapi/replay.json
index b4d1ba253b..351898f60d 100644
--- a/qapi/replay.json
+++ b/qapi/replay.json
@@ -81,7 +81,7 @@
 #
 # Example:
 #
-# -> { "execute": "replay-break", "data": { "icount": 220414 } }
+# -> { "execute": "replay-break", "arguments": { "icount": 220414 } }
 #
 ##
 { 'command': 'replay-break', 'data': { 'icount': 'int' } }
@@ -117,6 +117,6 @@
 #
 # Example:
 #
-# -> { "execute": "replay-seek", "data": { "icount": 220414 } }
+# -> { "execute": "replay-seek", "arguments": { "icount": 220414 } }
 ##
 { 'command': 'replay-seek', 'data': { 'icount': 'int' } }
-- 
2.35.1

Re: [PATCH v1 2/9] qapi: fix examples: replay-break and replay-seek

[Markus Armbruster]

Victor Toso <victortoso@redhat.com> writes:

> Both examples outputs are using @data member for the arguments. This
> is wrong. The expected member for the QMP is @arguments. Fix it.
>
> Signed-off-by: Victor Toso <victortoso@redhat.com>
> ---
>  qapi/replay.json | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/qapi/replay.json b/qapi/replay.json
> index b4d1ba253b..351898f60d 100644
> --- a/qapi/replay.json
> +++ b/qapi/replay.json
> @@ -81,7 +81,7 @@
>  #
>  # Example:
>  #
> -# -> { "execute": "replay-break", "data": { "icount": 220414 } }
> +# -> { "execute": "replay-break", "arguments": { "icount": 220414 } }
>  #
>  ##
>  { 'command': 'replay-break', 'data': { 'icount': 'int' } }
> @@ -117,6 +117,6 @@
>  #
>  # Example:
>  #
> -# -> { "execute": "replay-seek", "data": { "icount": 220414 } }
> +# -> { "execute": "replay-seek", "arguments": { "icount": 220414 } }
>  ##
>  { 'command': 'replay-seek', 'data': { 'icount': 'int' } }

I should've flagged these when I reviewed commit b1ca53224a
"qapi/migration: Fix examples document wrong field name for arguments".

Reviewed-by: Markus Armbruster <armbru@redhat.com>

[PATCH v1 3/9] qapi: fix example of query-named-block-nodes command

[Victor Toso]

Example output is missing mandatory member @detect_zeroes. Fix it.

Signed-off-by: Victor Toso <victortoso@redhat.com>
---
 qapi/block-core.json | 1 +
 1 file changed, 1 insertion(+)

diff --git a/qapi/block-core.json b/qapi/block-core.json
index 4a7a6940a3..beeb91952a 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -1776,6 +1776,7 @@
 #                    "file":"disks/test.qcow2",
 #                    "node-name": "my-node",
 #                    "backing_file_depth":1,
+#                    "detect_zeroes":"off",
 #                    "bps":1000000,
 #                    "bps_rd":0,
 #                    "bps_wr":0,
-- 
2.35.1

Re: [PATCH v1 3/9] qapi: fix example of query-named-block-nodes command

[Markus Armbruster]

Victor Toso <victortoso@redhat.com> writes:

> Example output is missing mandatory member @detect_zeroes. Fix it.
>
> Signed-off-by: Victor Toso <victortoso@redhat.com>
> ---
>  qapi/block-core.json | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index 4a7a6940a3..beeb91952a 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -1776,6 +1776,7 @@
>  #                    "file":"disks/test.qcow2",
>  #                    "node-name": "my-node",
>  #                    "backing_file_depth":1,
> +#                    "detect_zeroes":"off",
>  #                    "bps":1000000,
>  #                    "bps_rd":0,
>  #                    "bps_wr":0,

Reviewed-by: Markus Armbruster <armbru@redhat.com>

[PATCH v1 4/9] qapi: fix example of query-spice command

[Victor Toso]

Example output is missing mandatory members @migrated and @mouse-mode.
Fix it.

Signed-off-by: Victor Toso <victortoso@redhat.com>
---
 qapi/ui.json | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/qapi/ui.json b/qapi/ui.json
index a810ed680c..c039b8b3cb 100644
--- a/qapi/ui.json
+++ b/qapi/ui.json
@@ -324,8 +324,10 @@
 #          "enabled": true,
 #          "auth": "spice",
 #          "port": 5920,
+#          "migrated":false,
 #          "tls-port": 5921,
 #          "host": "0.0.0.0",
+#          "mouse-mode":"client",
 #          "channels": [
 #             {
 #                "port": "54924",
-- 
2.35.1

Re: [PATCH v1 4/9] qapi: fix example of query-spice command

[Markus Armbruster]

Victor Toso <victortoso@redhat.com> writes:

> Example output is missing mandatory members @migrated and @mouse-mode.
> Fix it.
>
> Signed-off-by: Victor Toso <victortoso@redhat.com>
> ---
>  qapi/ui.json | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/qapi/ui.json b/qapi/ui.json
> index a810ed680c..c039b8b3cb 100644
> --- a/qapi/ui.json
> +++ b/qapi/ui.json
> @@ -324,8 +324,10 @@
>  #          "enabled": true,
>  #          "auth": "spice",
>  #          "port": 5920,
> +#          "migrated":false,
>  #          "tls-port": 5921,
>  #          "host": "0.0.0.0",
> +#          "mouse-mode":"client",
>  #          "channels": [
>  #             {
>  #                "port": "54924",

Reviewed-by: Markus Armbruster <armbru@redhat.com>

[PATCH v1 5/9] qapi: fix example of query-vnc command

[Victor Toso]

The return value is missing the mandatory member @websocket. Fix it.

Signed-off-by: Victor Toso <victortoso@redhat.com>
---
 qapi/ui.json | 1 +
 1 file changed, 1 insertion(+)

diff --git a/qapi/ui.json b/qapi/ui.json
index c039b8b3cb..13a8bb82aa 100644
--- a/qapi/ui.json
+++ b/qapi/ui.json
@@ -658,6 +658,7 @@
 #                "host":"127.0.0.1",
 #                "service":"50401",
 #                "family":"ipv4"
+#                "websocket":false,
 #             }
 #          ]
 #       }
-- 
2.35.1

Re: [PATCH v1 5/9] qapi: fix example of query-vnc command

[Markus Armbruster]

Victor Toso <victortoso@redhat.com> writes:

> The return value is missing the mandatory member @websocket. Fix it.
>
> Signed-off-by: Victor Toso <victortoso@redhat.com>
> ---
>  qapi/ui.json | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/qapi/ui.json b/qapi/ui.json
> index c039b8b3cb..13a8bb82aa 100644
> --- a/qapi/ui.json
> +++ b/qapi/ui.json
> @@ -658,6 +658,7 @@
>  #                "host":"127.0.0.1",
>  #                "service":"50401",
>  #                "family":"ipv4"
> +#                "websocket":false,
>  #             }
>  #          ]
>  #       }

Reviewed-by: Markus Armbruster <armbru@redhat.com>

[PATCH v1 6/9] qapi: fix example of query-colo-status command

[Victor Toso]

The example output is missing the mandatory member @last-mode in the
return value. Fix it.

Signed-off-by: Victor Toso <victortoso@redhat.com>
---
 qapi/migration.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/qapi/migration.json b/qapi/migration.json
index 092a63354b..f74777608a 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -1679,7 +1679,7 @@
 # Example:
 #
 # -> { "execute": "query-colo-status" }
-# <- { "return": { "mode": "primary", "reason": "request" } }
+# <- { "return": { "mode": "primary", "last-mode": "none", "reason": "request" } }
 #
 # Since: 3.1
 ##
-- 
2.35.1

Re: [PATCH v1 6/9] qapi: fix example of query-colo-status command

[Markus Armbruster]

Victor Toso <victortoso@redhat.com> writes:

> The example output is missing the mandatory member @last-mode in the
> return value. Fix it.
>
> Signed-off-by: Victor Toso <victortoso@redhat.com>
> ---
>  qapi/migration.json | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/qapi/migration.json b/qapi/migration.json
> index 092a63354b..f74777608a 100644
> --- a/qapi/migration.json
> +++ b/qapi/migration.json
> @@ -1679,7 +1679,7 @@
>  # Example:
>  #
>  # -> { "execute": "query-colo-status" }
> -# <- { "return": { "mode": "primary", "reason": "request" } }
> +# <- { "return": { "mode": "primary", "last-mode": "none", "reason": "request" } }
>  #
>  # Since: 3.1
>  ##

Reviewed-by: Markus Armbruster <armbru@redhat.com>

[PATCH v1 7/9] qapi: fix example of trace-event-get-state command

[Victor Toso]

The example output is missing the mandatory member @vcpu. Fix it.

Signed-off-by: Victor Toso <victortoso@redhat.com>
---
 qapi/trace.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/qapi/trace.json b/qapi/trace.json
index 119509f565..6c6982a587 100644
--- a/qapi/trace.json
+++ b/qapi/trace.json
@@ -69,7 +69,7 @@
 #
 # -> { "execute": "trace-event-get-state",
 #      "arguments": { "name": "qemu_memalign" } }
-# <- { "return": [ { "name": "qemu_memalign", "state": "disabled" } ] }
+# <- { "return": [ { "name": "qemu_memalign", "state": "disabled", "vcpu": false } ] }
 #
 ##
 { 'command': 'trace-event-get-state',
-- 
2.35.1

Re: [PATCH v1 7/9] qapi: fix example of trace-event-get-state command

[Markus Armbruster]

Victor Toso <victortoso@redhat.com> writes:

> The example output is missing the mandatory member @vcpu. Fix it.
>
> Signed-off-by: Victor Toso <victortoso@redhat.com>
> ---
>  qapi/trace.json | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/qapi/trace.json b/qapi/trace.json
> index 119509f565..6c6982a587 100644
> --- a/qapi/trace.json
> +++ b/qapi/trace.json
> @@ -69,7 +69,7 @@
>  #
>  # -> { "execute": "trace-event-get-state",
>  #      "arguments": { "name": "qemu_memalign" } }
> -# <- { "return": [ { "name": "qemu_memalign", "state": "disabled" } ] }
> +# <- { "return": [ { "name": "qemu_memalign", "state": "disabled", "vcpu": false } ] }
>  #
>  ##
>  { 'command': 'trace-event-get-state',

Reviewed-by: Markus Armbruster <armbru@redhat.com>

[PATCH v1 8/9] qapi: fix example of query-cpus-fast command

[Victor Toso]

Example output contains member @arch that was removed in 445a5b4087
"machine: remove 'arch' field from 'query-cpus-fast' QMP command". Fix
it.

Signed-off-by: Victor Toso <victortoso@redhat.com>
---
 qapi/machine.json | 2 --
 1 file changed, 2 deletions(-)

diff --git a/qapi/machine.json b/qapi/machine.json
index 9c460ec450..968f912989 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -109,7 +109,6 @@
 #                 "socket-id": 0
 #             },
 #             "qom-path": "/machine/unattached/device[0]",
-#             "arch":"x86",
 #             "target":"x86_64",
 #             "cpu-index": 0
 #         },
@@ -121,7 +120,6 @@
 #                 "socket-id": 1
 #             },
 #             "qom-path": "/machine/unattached/device[2]",
-#             "arch":"x86",
 #             "target":"x86_64",
 #             "cpu-index": 1
 #         }
-- 
2.35.1

Re: [PATCH v1 8/9] qapi: fix example of query-cpus-fast command

[Markus Armbruster]

Victor Toso <victortoso@redhat.com> writes:

> Example output contains member @arch that was removed in 445a5b4087
> "machine: remove 'arch' field from 'query-cpus-fast' QMP command". Fix
> it.
>
> Signed-off-by: Victor Toso <victortoso@redhat.com>
> ---
>  qapi/machine.json | 2 --
>  1 file changed, 2 deletions(-)
>
> diff --git a/qapi/machine.json b/qapi/machine.json
> index 9c460ec450..968f912989 100644
> --- a/qapi/machine.json
> +++ b/qapi/machine.json
> @@ -109,7 +109,6 @@
>  #                 "socket-id": 0
>  #             },
>  #             "qom-path": "/machine/unattached/device[0]",
> -#             "arch":"x86",
>  #             "target":"x86_64",
>  #             "cpu-index": 0
>  #         },
> @@ -121,7 +120,6 @@
>  #                 "socket-id": 1
>  #             },
>  #             "qom-path": "/machine/unattached/device[2]",
> -#             "arch":"x86",
>  #             "target":"x86_64",
>  #             "cpu-index": 1
>  #         }

Reviewed-by: Markus Armbruster <armbru@redhat.com>

[PATCH v1 9/9] qapi: fix example of query-memdev command

[Victor Toso]

Example output is missing mandatory argument @share for the return
JSON object. Add it.

Signed-off-by: Victor Toso <victortoso@redhat.com>
---
 qapi/machine.json | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/qapi/machine.json b/qapi/machine.json
index 968f912989..d25a481ce4 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -839,6 +839,7 @@
 #          "merge": false,
 #          "dump": true,
 #          "prealloc": false,
+#          "share": false,
 #          "host-nodes": [0, 1],
 #          "policy": "bind"
 #        },
@@ -847,6 +848,7 @@
 #          "merge": false,
 #          "dump": true,
 #          "prealloc": true,
+#          "share": false,
 #          "host-nodes": [2, 3],
 #          "policy": "preferred"
 #        }
-- 
2.35.1

Re: [PATCH v1 9/9] qapi: fix example of query-memdev command

[Markus Armbruster]

Victor Toso <victortoso@redhat.com> writes:

> Example output is missing mandatory argument @share for the return
> JSON object. Add it.
>
> Signed-off-by: Victor Toso <victortoso@redhat.com>
> ---
>  qapi/machine.json | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/qapi/machine.json b/qapi/machine.json
> index 968f912989..d25a481ce4 100644
> --- a/qapi/machine.json
> +++ b/qapi/machine.json
> @@ -839,6 +839,7 @@
>  #          "merge": false,
>  #          "dump": true,
>  #          "prealloc": false,
> +#          "share": false,
>  #          "host-nodes": [0, 1],
>  #          "policy": "bind"
>  #        },
> @@ -847,6 +848,7 @@
>  #          "merge": false,
>  #          "dump": true,
>  #          "prealloc": true,
> +#          "share": false,
>  #          "host-nodes": [2, 3],
>  #          "policy": "preferred"
>  #        }

Reviewed-by: Markus Armbruster <armbru@redhat.com>

[PATCH 10/9] qapi: Fix calc-dirty-rate example

[Markus Armbruster]

The example shows {"command": ...}, which is wrong.  Fix it to
{"execute": ...}.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/migration.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/qapi/migration.json b/qapi/migration.json
index f74777608a..27d7b28158 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -1845,7 +1845,7 @@
 # Since: 5.2
 #
 # Example:
-#   {"command": "calc-dirty-rate", "arguments": {"calc-time": 1,
+#   {"execute": "calc-dirty-rate", "arguments": {"calc-time": 1,
 #                                                'sample-pages': 512} }
 #
 ##
-- 
2.35.1

Re: [PATCH 10/9] qapi: Fix calc-dirty-rate example

[Victor Toso]

[-- Attachment #1: Type: text/plain, Size: 840 bytes --]

On Fri, Apr 01, 2022 at 10:20:28AM +0200, Markus Armbruster wrote:
> The example shows {"command": ...}, which is wrong.  Fix it to
> {"execute": ...}.
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qapi/migration.json | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/qapi/migration.json b/qapi/migration.json
> index f74777608a..27d7b28158 100644
> --- a/qapi/migration.json
> +++ b/qapi/migration.json
> @@ -1845,7 +1845,7 @@
>  # Since: 5.2
>  #
>  # Example:
> -#   {"command": "calc-dirty-rate", "arguments": {"calc-time": 1,
> +#   {"execute": "calc-dirty-rate", "arguments": {"calc-time": 1,
>  #                                                'sample-pages': 512} }
>  #
>  ##
> -- 
> 2.35.1

Reviewed-by: Victor Toso <victortoso@redhat.com>

Cheers,
Victor

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH v1 0/9] Fix some qapi examples

[Markus Armbruster]

Victor Toso <victortoso@redhat.com> writes:

> Hi,
>
> I did another iteration of adding the examples in the qapi documentation
> as unit tests in another project and found a few that could be updated.
>
> Feel free to cherry-pick them. Happy to rework it if needed.

Queued, thanks!