From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: eduardo@habkost.net, marcel.apfelbaum@gmail.com,
philmd@linaro.org, wangyanan55@huawei.com, eblake@redhat.com,
mst@redhat.com, berrange@redhat.com, marcandre.lureau@redhat.com,
jsnow@redhat.com, imammedo@redhat.com
Subject: [PATCH 4/5] qapi/sockets: Move deprecation note out of SocketAddress doc comment
Date: Thu, 11 Jul 2024 13:22:27 +0200 [thread overview]
Message-ID: <20240711112228.2140606-5-armbru@redhat.com> (raw)
In-Reply-To: <20240711112228.2140606-1-armbru@redhat.com>
Doc comments are reference documentation for users of QMP.
SocketAddress's doc comment contains a deprecation note advising
developers to use SocketAddress for new code. Irrelevant for users of
QMP. Move the note out of the doc comment.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/sockets.json | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/qapi/sockets.json b/qapi/sockets.json
index 4d78d2ccb7..e76fdb9925 100644
--- a/qapi/sockets.json
+++ b/qapi/sockets.json
@@ -179,10 +179,6 @@
#
# @type: Transport type
#
-# .. note:: This type is deprecated in favor of SocketAddress. The
-# difference between SocketAddressLegacy and SocketAddress is that
-# the latter has fewer ``{}`` on the wire.
-#
# Since: 1.3
##
{ 'union': 'SocketAddressLegacy',
@@ -193,6 +189,9 @@
'unix': 'UnixSocketAddressWrapper',
'vsock': 'VsockSocketAddressWrapper',
'fd': 'FdSocketAddressWrapper' } }
+# Note: This type is deprecated in favor of SocketAddress. The
+# difference between SocketAddressLegacy and SocketAddress is that the
+# latter has fewer ``{}`` on the wire.
##
# @SocketAddressType:
--
2.45.0
next prev parent reply other threads:[~2024-07-11 11:23 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-11 11:22 [PATCH 0/5] qapi: Doc comment cleanups Markus Armbruster
2024-07-11 11:22 ` [PATCH 1/5] qapi/pci: Clean up documentation around PciDeviceClass Markus Armbruster
2024-07-16 16:07 ` John Snow
2024-07-11 11:22 ` [PATCH 2/5] qapi/machine: Clean up documentation around CpuInstanceProperties Markus Armbruster
2024-07-16 16:08 ` John Snow
2024-07-11 11:22 ` [PATCH 3/5] qapi/machine: Clarify query-uuid value when none has been specified Markus Armbruster
2024-07-16 16:14 ` John Snow
2024-07-16 18:12 ` Markus Armbruster
2024-07-16 21:16 ` Philippe Mathieu-Daudé
2024-07-11 11:22 ` Markus Armbruster [this message]
2024-07-16 16:15 ` [PATCH 4/5] qapi/sockets: Move deprecation note out of SocketAddress doc comment John Snow
2024-07-16 21:17 ` Philippe Mathieu-Daudé
2024-07-11 11:22 ` [PATCH 5/5] qapi/ui: Drop note on naming of SpiceQueryMouseMode Markus Armbruster
2024-07-16 16:21 ` John Snow
2024-07-16 16:18 ` [PATCH 0/5] qapi: Doc comment cleanups Michael S. Tsirkin
2024-07-17 10:46 ` 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=20240711112228.2140606-5-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=eblake@redhat.com \
--cc=eduardo@habkost.net \
--cc=imammedo@redhat.com \
--cc=jsnow@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=marcel.apfelbaum@gmail.com \
--cc=mst@redhat.com \
--cc=philmd@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=wangyanan55@huawei.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).