From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: stefanha@redhat.com, Eric Blake <eblake@redhat.com>
Subject: [PULL 08/11] qapi/qapi-schema: Update introduction for example notation
Date: Tue, 8 Apr 2025 09:19:58 +0200 [thread overview]
Message-ID: <20250408072001.2518323-9-armbru@redhat.com> (raw)
In-Reply-To: <20250408072001.2518323-1-armbru@redhat.com>
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>
---
qapi/qapi-schema.json | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json
index c41c01eb2a..0d027d5017 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>`
--
2.48.1
next prev parent reply other threads:[~2025-04-08 7:22 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-04-08 7:19 [PULL 00/11] QAPI patches patches for 2025-04-08 Markus Armbruster
2025-04-08 7:19 ` [PULL 01/11] docs/devel/qapi-code-gen: Tidy up whitespace Markus Armbruster
2025-04-08 7:19 ` [PULL 02/11] qapi/rocker: Tidy up query-rocker-of-dpa-flows example Markus Armbruster
2025-04-08 7:19 ` [PULL 03/11] docs/interop: Delete "QEMU Guest Agent Protocol Reference" TOC Markus Armbruster
2025-04-08 7:19 ` [PULL 04/11] docs/interop: Sanitize QMP reference manuals TOC Markus Armbruster
2025-04-08 7:19 ` [PULL 05/11] docs/devel/qapi-code-gen: Improve the part on qmp-example directive Markus Armbruster
2025-04-08 7:19 ` [PULL 06/11] docs/sphinx/qmp_lexer: Generalize elision syntax Markus Armbruster
2025-04-08 7:19 ` [PULL 07/11] docs/sphinx/qmp_lexer: Highlight elisions like comments, not prompts Markus Armbruster
2025-04-08 7:19 ` Markus Armbruster [this message]
2025-04-08 7:19 ` [PULL 09/11] qapi/qapi-schema: Address the introduction's bit rot Markus Armbruster
2025-04-08 7:20 ` [PULL 10/11] storage-daemon/qapi/qapi-schema: Add a proper introduction Markus Armbruster
2025-04-08 7:20 ` [PULL 11/11] qga/qapi-schema: " Markus Armbruster
2025-04-08 7:45 ` [PULL 00/11] QAPI patches patches for 2025-04-08 Markus Armbruster
2025-04-09 8:31 ` Stefan Hajnoczi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250408072001.2518323-9-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).