John Snow 6f07c59fb1 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>		2024-07-17 10:20:53 +02:00
..
acpi.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
audio.json	audio/pw: Pipewire->PipeWire case fix for user-visible text	2023-07-17 15:22:56 +04:00
authz.json	qapi: Reformat doc comments to conform to current conventions	2023-05-10 10:01:01 +02:00
block-core.json	qapi: convert "Example" sections with titles	2024-07-17 10:20:53 +02:00
block-export.json	qapi: Move error documentation to new "Errors" sections	2024-03-04 07:12:40 +01:00
block.json	qapi: convert "Example" sections with longer prose	2024-07-17 10:20:53 +02:00
char.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
common.json	qapi: document PCIe Gen5/Gen6 speeds since 9.0	2024-03-18 04:57:45 -04:00
compat.json	qapi: Belatedly update CompatPolicy documentation for unstable	2023-10-19 07:02:29 +02:00
control.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
crypto.json	qapi: Correct documentation indentation and whitespace	2024-03-26 06:36:08 +01:00
cryptodev.json	spelling: information	2023-06-09 23:38:16 +03:00
cxl.json	hw/cxl/events: Mark cxl-add-dynamic-capacity and cxl-release-dynamic-capcity unstable	2024-07-03 18:14:07 -04:00
dump.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
ebpf.json	qapi: Refill doc comments to conform to current conventions	2024-03-26 06:36:08 +01:00
error.json	qapi: Reformat doc comments to conform to current conventions	2023-05-10 10:01:01 +02:00
introspect.json	qapi: convert "Note" sections to plain rST	2024-07-06 08:58:24 +02:00
job.json	blockjob: introduce block-job-change QMP command	2023-10-31 18:20:25 +01:00
machine-common.json	CPU topology: extend with s390 specifics	2023-10-20 07:16:53 +02:00
machine-target.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
machine.json	qapi: convert "Example" sections with longer prose	2024-07-17 10:20:53 +02:00
meson.build	qapi/vfio: Add VFIO migration QAPI event	2024-05-16 16:59:19 +02:00
migration.json	qapi: convert "Example" sections with longer prose	2024-07-17 10:20:53 +02:00
misc-target.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
misc.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
net.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
opts-visitor.c	qapi: Inline and remove QERR_INVALID_PARAMETER definition	2024-04-24 09:50:58 +02:00
pci.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
pragma.json	qapi: document parameters of query-cpu-model-* QAPI commands	2024-03-26 06:36:08 +01:00
qapi-clone-visitor.c	qapi: Do not cast function pointers	2024-05-29 12:41:56 +02:00
qapi-dealloc-visitor.c
qapi-forward-visitor.c
qapi-schema.json	qapi/vfio: Add VFIO migration QAPI event	2024-05-16 16:59:19 +02:00
qapi-type-helpers.c	qapi: New strv_from_str_list()	2024-03-04 07:12:40 +01:00
qapi-util.c	qapi: Fix dangling references to docs/devel/qapi-code-gen.txt	2024-01-26 07:04:53 +01:00
qapi-visit-core.c
qdev.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
qmp-dispatch.c	Revert "monitor: use aio_co_reschedule_self()"	2024-06-10 11:05:43 +02:00
qmp-event.c
qmp-registry.c
qobject-input-visitor.c	qapi: Inline QERR_INVALID_PARAMETER_TYPE definition (constant value)	2024-04-24 09:50:58 +02:00
qobject-output-visitor.c
qom.json	qapi: convert "Example" sections with titles	2024-07-17 10:20:53 +02:00
replay.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
rocker.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
run-state.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
sockets.json	qapi/sockets: Move deprecation note out of SocketAddress doc comment	2024-07-17 10:15:04 +02:00
stats.json	qapi: convert "Note" sections to plain rST	2024-07-06 08:58:24 +02:00
string-input-visitor.c	qapi: Inline QERR_INVALID_PARAMETER_TYPE definition (constant value)	2024-04-24 09:50:58 +02:00
string-output-visitor.c	string-output-visitor: Fix (pseudo) struct handling	2024-01-26 11:16:58 +01:00
tpm.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
trace-events
trace.h
trace.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
transaction.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
ui.json	qapi: convert "Example" sections with titles	2024-07-17 10:20:53 +02:00
vfio.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00
virtio.json	qapi: convert "Example" sections with longer prose	2024-07-17 10:20:53 +02:00
yank.json	qapi: convert "Example" sections without titles	2024-07-17 10:20:53 +02:00