diff options
| author | Markus Armbruster <armbru@redhat.com> | 2023-04-25 08:42:14 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2023-04-28 11:48:34 +0200 |
| commit | 37fa48a4cbd68760235293ebf95980fb87239b42 (patch) | |
| tree | a2c7859d90cd2d77044b4c895071ab3df69ae54a /qapi/block-core.json | |
| parent | f1a787b5f4b60524580ed9d1527568590d73789b (diff) | |
| download | qemu-37fa48a4cbd68760235293ebf95980fb87239b42.zip qemu-37fa48a4cbd68760235293ebf95980fb87239b42.tar.gz qemu-37fa48a4cbd68760235293ebf95980fb87239b42.tar.bz2 | |
qapi: Tidy up examples
A few examples neglect to prefix QMP input with '->'. Fix that.
Two examples have extra space after '<-'. Delete it.
A few examples neglect to show output. Provide some. The example
output for query-vcpu-dirty-limit could use further improvement. Add
a TODO comment.
Use "Examples:" instead of "Example:" where multiple examples are
given.
One example section numbers its two examples. Not done elsewhere;
drop.
Another example section separates them with "or". Likewise.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <20230425064223.820979-8-armbru@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
Diffstat (limited to 'qapi/block-core.json')
| -rw-r--r-- | qapi/block-core.json | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/qapi/block-core.json b/qapi/block-core.json index eeb2ed3..a5a5007 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -4574,9 +4574,8 @@ # # Since: 2.9 # -# Example: +# Examples: # -# 1. # -> { "execute": "blockdev-add", # "arguments": { # "driver": "qcow2", @@ -4589,7 +4588,6 @@ # } # <- { "return": {} } # -# 2. # -> { "execute": "blockdev-add", # "arguments": { # "driver": "qcow2", @@ -5596,7 +5594,7 @@ # # Since: 2.7 # -# Example: +# Examples: # # 1. Add a new node to a quorum # -> { "execute": "blockdev-add", @@ -5646,7 +5644,7 @@ # # Since: 2.12 # -# Example: +# Examples: # # 1. Move a node into an IOThread # -> { "execute": "x-blockdev-set-iothread", @@ -5731,18 +5729,18 @@ # # Since: 2.0 # -# Example: +# Examples: # # 1. Read operation # -# { "event": "QUORUM_REPORT_BAD", +# <- { "event": "QUORUM_REPORT_BAD", # "data": { "node-name": "node0", "sector-num": 345435, "sectors-count": 5, # "type": "read" }, # "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } # # 2. Flush operation # -# { "event": "QUORUM_REPORT_BAD", +# <- { "event": "QUORUM_REPORT_BAD", # "data": { "node-name": "node0", "sector-num": 0, "sectors-count": 2097120, # "type": "flush", "error": "Broken pipe" }, # "timestamp": { "seconds": 1456406829, "microseconds": 291763 } } |