From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: stefanha@redhat.com, Eric Blake <eblake@redhat.com>
Subject: [PULL 10/11] storage-daemon/qapi/qapi-schema: Add a proper introduction
Date: Tue, 8 Apr 2025 09:20:00 +0200 [thread overview]
Message-ID: <20250408072001.2518323-11-armbru@redhat.com> (raw)
In-Reply-To: <20250408072001.2518323-1-armbru@redhat.com>
Contents adapted from qapi/qapi-schema.json.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20250404121413.1743790-11-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
---
storage-daemon/qapi/qapi-schema.json | 22 +++++++++++++++++++---
1 file changed, 19 insertions(+), 3 deletions(-)
diff --git a/storage-daemon/qapi/qapi-schema.json b/storage-daemon/qapi/qapi-schema.json
index 2a562ee32e..0427594c98 100644
--- a/storage-daemon/qapi/qapi-schema.json
+++ b/storage-daemon/qapi/qapi-schema.json
@@ -14,10 +14,26 @@
# storage daemon.
##
-# = QEMU storage daemon protocol commands and structs
+# = Introduction
#
-# For a concise listing of all commands, events, and types in the QEMU
-# storage daemon, please consult the `qapi-qsd-index`.
+# This manual describes the commands and events supported by the QEMU
+# storage daemon QMP.
+#
+# For locating a particular item, please see the `qapi-qsd-index`.
+#
+# The following notation is used in examples:
+#
+# .. qmp-example::
+#
+# -> ... text sent by client (commands) ...
+# <- ... text sent by server (command responses and events) ...
+#
+# Example text is formatted for readability. However, in real
+# protocol usage, its commonly emitted as a single line.
+#
+# Please refer to the
+# :doc:`QEMU Machine Protocol Specification </interop/qmp-spec>`
+# for the general format of commands, responses, and events.
##
--
2.48.1
next prev parent reply other threads:[~2025-04-08 7:21 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 ` [PULL 08/11] qapi/qapi-schema: Update introduction for example notation Markus Armbruster
2025-04-08 7:19 ` [PULL 09/11] qapi/qapi-schema: Address the introduction's bit rot Markus Armbruster
2025-04-08 7:20 ` Markus Armbruster [this message]
2025-04-08 7:20 ` [PULL 11/11] qga/qapi-schema: Add a proper introduction 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-11-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).