aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2025-04-04 14:14:10 +0200
committerMarkus Armbruster <armbru@redhat.com>2025-04-08 09:04:34 +0200
commitd0ae5a3058603d4b2c25984a3acb2ac83e025424 (patch)
treeafbcc84de0f8a21ff7ca9a8a149c6f0ad6842481
parent6d7b3efc3fa83aec4cb09000893064907def811d (diff)
downloadqemu-d0ae5a3058603d4b2c25984a3acb2ac83e025424.zip
qemu-d0ae5a3058603d4b2c25984a3acb2ac83e025424.tar.gz
qemu-d0ae5a3058603d4b2c25984a3acb2ac83e025424.tar.bz2
qapi/qapi-schema: Update introduction for example notation
The introduction explains example notation. The series merged in merge commit e6485190f77e (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>
-rw-r--r--qapi/qapi-schema.json6
1 files changed, 3 insertions, 3 deletions
diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json
index c41c01e..0d027d5 100644
--- 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>`