qapi/qapi-schema: Update introduction for example notation

Markus Armbruster · Markus Armbruster · commit d0ae5a305860 · 2025-04-08T09:04:34.000+02:00
The introduction explains example notation. The series merged in merge commit e648519 (in 9.1) improved how they look in generated docs, but neglected to update the introduction accordingly. Do that now. Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-ID: <20250404121413.1743790-9-armbru@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com>
diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json
@@ -26,10 +26,10 @@
 #
 # Example:
 #
-# ::
+# .. qmp-example::
 #
-#   -> data issued by the Client
-#   <- Server data response
+#   -> ... text sent by client (commands) ...
+#   <- ... text sent by server (command responses and events) ...
 #
 # Please refer to the
 # :doc:`QEMU Machine Protocol Specification </interop/qmp-spec>`

Original file line number	Diff line number	Diff line change
`@@ -26,10 +26,10 @@`
`26`	`26`	`#`
`27`	`27`	`# Example:`
`28`	`28`	`#`
`29`		`-# ::`
	`29`	`+# .. qmp-example::`
`30`	`30`	`#`
`31`		`-# -> data issued by the Client`
`32`		`-# <- Server data response`
	`31`	`+# -> ... text sent by client (commands) ...`
	`32`	`+# <- ... text sent by server (command responses and events) ...`
`33`	`33`	`#`
`34`	`34`	`# Please refer to the`
`35`	`35`	# :doc:`QEMU Machine Protocol Specification </interop/qmp-spec>`