]> git.ipfire.org Git - thirdparty/qemu.git/commit
qapi: convert "Example" sections without titles
authorJohn Snow <jsnow@redhat.com>
Wed, 17 Jul 2024 02:13:08 +0000 (22:13 -0400)
committerMarkus Armbruster <armbru@redhat.com>
Wed, 17 Jul 2024 08:20:53 +0000 (10:20 +0200)
commit14b48aaab92de5962e8cdb563875fc6937ef916e
treeb04def230ba992ced3b783f5d5ac40b91b8923a1
parente597a73a8c561141f757b3b1ef13470ebdec5640
qapi: convert "Example" sections without titles

Use the no-option form of ".. qmp-example::" to convert any Examples
that do not have any form of caption or explanation whatsoever. Note
that in a few cases, example sections are split into two or more
separate example blocks. This is only done stylistically to create a
delineation between two or more logically independent examples.

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

See commit+3: "qapi: remove "Example" doc section" for a detailed
              explanation of why.

Note: an empty "TODO" line was added to announce-self to keep the
example from floating up into the body; this will be addressed more
rigorously in the new qapidoc generator.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20240717021312.606116-7-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Markup fixed in one place]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
25 files changed:
qapi/acpi.json
qapi/block-core.json
qapi/block.json
qapi/char.json
qapi/control.json
qapi/dump.json
qapi/machine-target.json
qapi/machine.json
qapi/migration.json
qapi/misc-target.json
qapi/misc.json
qapi/net.json
qapi/pci.json
qapi/qdev.json
qapi/qom.json
qapi/replay.json
qapi/rocker.json
qapi/run-state.json
qapi/tpm.json
qapi/trace.json
qapi/transaction.json
qapi/ui.json
qapi/vfio.json
qapi/virtio.json
qapi/yank.json