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/char.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/char.json')
| -rw-r--r-- | qapi/char.json | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/qapi/char.json b/qapi/char.json index 923dc50..c9431dd 100644 --- a/qapi/char.json +++ b/qapi/char.json @@ -637,7 +637,7 @@ # # Since: 1.4 # -# Example: +# Examples: # # -> { "execute" : "chardev-add", # "arguments" : { "id" : "foo", @@ -673,7 +673,7 @@ # # Since: 2.10 # -# Example: +# Examples: # # -> { "execute" : "chardev-change", # "arguments" : { "id" : "baz", |