From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: michael.roth@amd.com, kkostiuk@redhat.com, kwolf@redhat.com,
jsnow@redhat.com, peter.maydell@linaro.org, eblake@redhat.com,
jiri@resnulli.us, qemu-block@nongnu.org
Subject: [PATCH 11/11] qga/qapi-schema: Add a proper introduction
Date: Fri, 4 Apr 2025 14:14:13 +0200 [thread overview]
Message-ID: <20250404121413.1743790-12-armbru@redhat.com> (raw)
In-Reply-To: <20250404121413.1743790-1-armbru@redhat.com>
Contents adapted from qapi/qapi-schema.json.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qga/qapi-schema.json | 20 +++++++++++++++++---
1 file changed, 17 insertions(+), 3 deletions(-)
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index 35ec0e7db3..5316bfacbf 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -2,10 +2,24 @@
# vim: filetype=python
##
-# = QEMU guest agent protocol commands and structs
+# This manual describes the commands supported by the QEMU Guest
+# Agent Protocol.
#
-# For a concise listing of all commands, events, and types in the QEMU
-# guest agent, please consult the `qapi-qga-index`.
+# For locating a particular item, please see the `qapi-qga-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.
##
{ 'pragma': { 'doc-required': true } }
--
2.48.1
next prev parent reply other threads:[~2025-04-04 12:17 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-04-04 12:14 [PATCH 00/11] qapi: Documentation improvements Markus Armbruster
2025-04-04 12:14 ` [PATCH 01/11] docs/devel/qapi-code-gen: Tidy up whitespace Markus Armbruster
2025-04-04 12:14 ` [PATCH 02/11] qapi/rocker: Tidy up query-rocker-of-dpa-flows example Markus Armbruster
2025-04-07 15:06 ` Eric Blake
2025-04-08 7:04 ` Markus Armbruster
2025-04-04 12:14 ` [PATCH 03/11] docs/interop: Delete "QEMU Guest Agent Protocol Reference" TOC Markus Armbruster
2025-04-04 12:14 ` [PATCH 04/11] docs/interop: Sanitize QMP reference manuals TOC Markus Armbruster
2025-04-04 12:14 ` [PATCH 05/11] docs/devel/qapi-code-gen: Improve the part on qmp-example directive Markus Armbruster
2025-04-04 12:14 ` [PATCH 06/11] docs/sphinx/qmp_lexer: Generalize elision syntax Markus Armbruster
2025-04-07 15:15 ` Eric Blake
2025-04-08 20:46 ` John Snow
2025-04-09 5:50 ` Markus Armbruster
2025-04-04 12:14 ` [PATCH 07/11] docs/sphinx/qmp_lexer: Highlight elisions like comments, not prompts Markus Armbruster
2025-04-04 12:14 ` [PATCH 08/11] qapi/qapi-schema: Update introduction for example notation Markus Armbruster
2025-04-04 12:14 ` [PATCH 09/11] qapi/qapi-schema: Address the introduction's bit rot Markus Armbruster
2025-04-17 18:17 ` John Snow
2025-04-04 12:14 ` [PATCH 10/11] storage-daemon/qapi/qapi-schema: Add a proper introduction Markus Armbruster
2025-04-04 12:14 ` Markus Armbruster [this message]
2025-04-07 15:18 ` [PATCH 00/11] qapi: Documentation improvements Eric Blake
2025-04-08 7:22 ` Markus Armbruster
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=20250404121413.1743790-12-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=jiri@resnulli.us \
--cc=jsnow@redhat.com \
--cc=kkostiuk@redhat.com \
--cc=kwolf@redhat.com \
--cc=michael.roth@amd.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
/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).