소스 검색

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>
Markus Armbruster 4 달 전
부모
커밋
d0ae5a3058
1개의 변경된 파일3개의 추가작업 그리고 3개의 파일을 삭제
  1. 3 3
      qapi/qapi-schema.json

+ 3 - 3
qapi/qapi-schema.json

@@ -26,10 +26,10 @@
 #
 #
 # Example:
 # 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
 # Please refer to the
 # :doc:`QEMU Machine Protocol Specification </interop/qmp-spec>`
 # :doc:`QEMU Machine Protocol Specification </interop/qmp-spec>`