qapi: convert "Example" sections with titles
commita9eab6e2e65f5b876ededec1cd4bacc58cd4bce0
authorJohn Snow <jsnow@redhat.com>
Wed, 17 Jul 2024 02:13:09 +0000 (16 22:13 -0400)
committerMarkus Armbruster <armbru@redhat.com>
Wed, 17 Jul 2024 08:20:53 +0000 (17 10:20 +0200)
treeb07d0d796d492ea76d4f6eb8ef1d1a5f73e9a070
parent14b48aaab92de5962e8cdb563875fc6937ef916e
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>
qapi/block-core.json
qapi/block.json
qapi/migration.json
qapi/qom.json
qapi/ui.json
qapi/virtio.json