[v3] Fix some qapi examples and a TODO section

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

Victor Toso posted 14 patches 2 years, 1 month ago

Diff against v1 v2
Download series mbox

Test checkpatch passed

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20220328140604.41484-1-victortoso@redhat.com

Maintainers: Eric Blake <eblake@redhat.com>, Markus Armbruster <armbru@redhat.com>, "Michael S. Tsirkin" <mst@redhat.com>, Igor Mammedov <imammedo@redhat.com>, Ani Sinha <ani@anisinha.ca>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, Eduardo Habkost <eduardo@habkost.net>, Marcel Apfelbaum <marcel.apfelbaum@gmail.com>, "Philippe Mathieu-Daudé" <f4bug@amsat.org>, Yanan Wang <wangyanan55@huawei.com>, Juan Quintela <quintela@redhat.com>, "Dr. David Alan Gilbert" <dgilbert@redhat.com>, Jason Wang <jasowang@redhat.com>, Paolo Bonzini <pbonzini@redhat.com>, Gerd Hoffmann <kraxel@redhat.com>

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(-)

Expand all Fold all

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

Posted by Victor Toso 2 years, 1 month ago

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(-)

-- 
2.35.1

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

Posted by Markus Armbruster 2 years, 1 month ago

Victor Toso <victortoso@redhat.com> writes:

> 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!

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

Posted by Markus Armbruster 2 years, 1 month ago

Victor Toso <victortoso@redhat.com> writes:

> 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!

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

Posted by John Snow 2 years, 1 month ago

On Tue, Mar 29, 2022 at 12:00 PM Markus Armbruster <armbru@redhat.com> wrote:
>
> Victor Toso <victortoso@redhat.com> writes:
>
> > 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.

Reviewed-by: John Snow <jsnow@redhat.com>

Thanks!