diff options
| author | John Snow <jsnow@redhat.com> | 2024-07-16 22:13:09 -0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2024-07-17 10:20:53 +0200 |
| commit | a9eab6e2e65f5b876ededec1cd4bacc58cd4bce0 (patch) | |
| tree | b07d0d796d492ea76d4f6eb8ef1d1a5f73e9a070 /qapi/ui.json | |
| parent | 14b48aaab92de5962e8cdb563875fc6937ef916e (diff) | |
| download | qemu-a9eab6e2e65f5b876ededec1cd4bacc58cd4bce0.zip qemu-a9eab6e2e65f5b876ededec1cd4bacc58cd4bce0.tar.gz qemu-a9eab6e2e65f5b876ededec1cd4bacc58cd4bce0.tar.bz2 | |
qapi: convert "Example" sections with titles
When an Example section has a brief explanation, convert it to a
qmp-example:: section using the :title: option.
Rule of thumb: If the title can fit on a single line and requires no rST
markup, it's a good candidate for using the :title: option of
qmp-example.
In this patch, trailing punctuation is removed from the title section
for consistent headline aesthetics. In just one case, specifics of the
example are removed to make the title read better.
See commit-4: "docs/qapidoc: create qmp-example directive", for a
detailed explanation of this custom directive syntax.
See commit+2: "qapi: remove "Example" doc section" for a detailed
explanation of why.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240717021312.606116-8-jsnow@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'qapi/ui.json')
| -rw-r--r-- | qapi/ui.json | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/qapi/ui.json b/qapi/ui.json index 6bda984..5daca51 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -1270,9 +1270,8 @@ # property, so it is possible to map which console belongs to which # device and display. # -# Examples: -# -# 1. Press left mouse button. +# .. qmp-example:: +# :title: Press left mouse button # # -> { "execute": "input-send-event", # "arguments": { "device": "video0", @@ -1286,7 +1285,8 @@ # "data" : { "down": false, "button": "left" } } ] } } # <- { "return": {} } # -# 2. Press ctrl-alt-del. +# .. qmp-example:: +# :title: Press ctrl-alt-del # # -> { "execute": "input-send-event", # "arguments": { "events": [ @@ -1298,7 +1298,8 @@ # "key": {"type": "qcode", "data": "delete" } } } ] } } # <- { "return": {} } # -# 3. Move mouse pointer to absolute coordinates (20000, 400). +# .. qmp-example:: +# :title: Move mouse pointer to absolute coordinates # # -> { "execute": "input-send-event" , # "arguments": { "events": [ |