summary refs log tree commit diff stats
path: root/scripts/qapi
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2024-07-16 22:13:10 -0400
committerMarkus Armbruster <armbru@redhat.com>2024-07-17 10:20:53 +0200
commit6f07c59fb16c68e91de82c086ce6c27d9e4748ca (patch)
treede54c14c08f2c5b170851b904e30f3a2bb1fa881 /scripts/qapi
parenta9eab6e2e65f5b876ededec1cd4bacc58cd4bce0 (diff)
downloadfocaccia-qemu-6f07c59fb16c68e91de82c086ce6c27d9e4748ca.tar.gz
focaccia-qemu-6f07c59fb16c68e91de82c086ce6c27d9e4748ca.zip
qapi: convert "Example" sections with longer prose
These examples require longer explanations or have explanations that
require markup to look reasonable when rendered and so use the longer
form of the ".. qmp-example::" directive.

By using the :annotated: option, the content in the example block is
assumed *not* to be a code block literal and is instead parsed as normal
rST - with the exception that any code literal blocks after `::` will
assumed to be a QMP code literal block.

Note: There's one title-less conversion in this patch that comes along
for the ride because it's part of a larger "Examples" block that was
better to convert all at once.

See commit-5: "docs/qapidoc: create qmp-example directive", for a
              detailed explanation of this custom directive syntax.

See commit+1: "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-9-jsnow@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'scripts/qapi')
0 files changed, 0 insertions, 0 deletions