From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: eblake@redhat.com, marcandre.lureau@redhat.com,
pbonzini@redhat.com, berrange@redhat.com, mst@redhat.com,
marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com
Subject: [PATCH 1/6] qapi/char: Supply missing member documentation
Date: Thu, 8 Aug 2024 20:26:31 +0200 [thread overview]
Message-ID: <20240808182636.3657537-2-armbru@redhat.com> (raw)
In-Reply-To: <20240808182636.3657537-1-armbru@redhat.com>
Since we neglect to document several members of ChardevBackendKind,
their description in the QEMU QMP Reference manual is "Not
documented". Fix that, and improve the existing member documentation.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/char.json | 44 ++++++++++++++++++++++++++++----------------
qapi/pragma.json | 1 -
2 files changed, 28 insertions(+), 17 deletions(-)
diff --git a/qapi/char.json b/qapi/char.json
index ef58445cee..8a4a87c95c 100644
--- a/qapi/char.json
+++ b/qapi/char.json
@@ -434,37 +434,49 @@
##
# @ChardevBackendKind:
#
-# @pipe: Since 1.5
+# @file: regular files
#
-# @udp: Since 1.5
+# @serial: serial host device
#
-# @mux: Since 1.5
+# @parallel: parallel host device
#
-# @msmouse: Since 1.5
+# @pipe: pipes (since 1.5)
#
-# @wctablet: Since 2.9
+# @socket: stream socket
#
-# @braille: Since 1.5
+# @udp: datagram socket (since 1.5)
#
-# @testdev: Since 2.2
+# @pty: pseudo-terminal
#
-# @stdio: Since 1.5
+# @null: provides no input, throws away output
#
-# @console: Since 1.5
+# @mux: (since 1.5)
#
-# @spicevmc: Since 1.5
+# @msmouse: emulated Microsoft serial mouse (since 1.5)
#
-# @spiceport: Since 1.5
+# @wctablet: emulated Wacom Penpartner serial tablet (since 2.9)
#
-# @qemu-vdagent: Since 6.1
+# @braille: Baum Braille device (since 1.5)
#
-# @dbus: Since 7.0
+# @testdev: device for test-suite control (since 2.2)
#
-# @vc: v1.5
+# @stdio: standard I/O (since 1.5)
#
-# @ringbuf: Since 1.6
+# @console: Windows console (since 1.5)
#
-# @memory: Since 1.5
+# @spicevmc: spice vm channel (since 1.5)
+#
+# @spiceport: Spice port channel (since 1.5)
+#
+# @qemu-vdagent: Spice vdagent (since 6.1)
+#
+# @dbus: D-Bus channel (since 7.0)
+#
+# @vc: virtual console (since v1.5)
+#
+# @ringbuf: memory ring buffer (since 1.6)
+#
+# @memory: synonym for @ringbuf (since 1.5)
#
# Features:
#
diff --git a/qapi/pragma.json b/qapi/pragma.json
index 59fbe74b8c..39a424303b 100644
--- a/qapi/pragma.json
+++ b/qapi/pragma.json
@@ -46,7 +46,6 @@
'BlockdevSnapshotSyncWrapper',
'BlockdevSnapshotWrapper',
'BlockdevVmdkAdapterType',
- 'ChardevBackendKind',
'CpuS390Entitlement',
'CpuS390Polarization',
'CpuS390State',
--
2.45.0
next prev parent reply other threads:[~2024-08-08 18:27 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-08 18:26 [PATCH 0/6] qapi: Supply some of the missing member documentation Markus Armbruster
2024-08-08 18:26 ` Markus Armbruster [this message]
2024-08-08 20:48 ` [PATCH 1/6] qapi/char: Supply " John Snow
2024-08-09 4:51 ` Markus Armbruster
2024-08-09 8:44 ` Philippe Mathieu-Daudé
2024-08-09 9:11 ` Markus Armbruster
2024-08-12 18:10 ` John Snow
2024-08-08 18:26 ` [PATCH 2/6] qapi/common: " Markus Armbruster
2024-08-09 8:38 ` Philippe Mathieu-Daudé
2024-08-08 18:26 ` [PATCH 3/6] qapi/crypto: " Markus Armbruster
2024-08-09 8:39 ` Philippe Mathieu-Daudé
2024-08-08 18:26 ` [PATCH 4/6] qapi/introspect: " Markus Armbruster
2024-08-09 12:27 ` Eric Blake
2024-08-08 18:26 ` [PATCH 5/6] qapi/pci: " Markus Armbruster
2024-08-09 8:41 ` Philippe Mathieu-Daudé
2024-08-08 18:26 ` [PATCH 6/6] qapi/rocker: " Markus Armbruster
2024-08-09 8:41 ` Philippe Mathieu-Daudé
2024-08-08 20:51 ` [PATCH 0/6] qapi: Supply some of the " John Snow
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=20240808182636.3657537-2-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=eblake@redhat.com \
--cc=jiri@resnulli.us \
--cc=jsnow@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=marcel.apfelbaum@gmail.com \
--cc=mst@redhat.com \
--cc=pbonzini@redhat.com \
--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).