Re: [PATCH 00/14] Fix some qapi examples and a TODO section

[John Snow <jsnow@redhat.com>]

On Thu, Mar 24, 2022 at 1:50 PM Victor Toso <victortoso@redhat.com> wrote:
>
> 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.
>
> 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: run-state examples: add missing member
>   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   |  9 +++++----
>  qapi/block-export.json | 10 +++++-----
>  qapi/dump.json         |  9 +++++----
>  qapi/machine.json      |  3 ++-
>  qapi/migration.json    |  4 +++-
>  qapi/net.json          |  3 ++-
>  qapi/run-state.json    | 16 +++++++++++-----
>  qapi/ui.json           | 12 ++++++------
>  9 files changed, 42 insertions(+), 29 deletions(-)
>
> --
> 2.35.1
>

Good stuff, IMO. Systematically validating our docs will be a good
thing for improving the usability of those docs.

Only the first patch seems like a lateral move, but I assume you had
your reasons.

--js