[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 05/14] qapi/sockets: Move deprecation note out of SocketAddress do
From: |
Markus Armbruster |
Subject: |
[PULL 05/14] qapi/sockets: Move deprecation note out of SocketAddress doc comment |
Date: |
Wed, 17 Jul 2024 12:48:58 +0200 |
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>
Message-ID: <20240711112228.2140606-5-armbru@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
---
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
- [PULL 00/14] QAPI patches patches for 2024-07-17, Markus Armbruster, 2024/07/17
- [PULL 02/14] qapi/pci: Clean up documentation around PciDeviceClass, Markus Armbruster, 2024/07/17
- [PULL 04/14] qapi/machine: Clarify query-uuid value when none has been specified, Markus Armbruster, 2024/07/17
- [PULL 03/14] qapi/machine: Clean up documentation around CpuInstanceProperties, Markus Armbruster, 2024/07/17
- [PULL 12/14] qapi: convert "Example" sections with titles, Markus Armbruster, 2024/07/17
- [PULL 06/14] qapi/ui: Drop note on naming of SpiceQueryMouseMode, Markus Armbruster, 2024/07/17
- [PULL 05/14] qapi/sockets: Move deprecation note out of SocketAddress doc comment,
Markus Armbruster <=
- [PULL 01/14] qapi/qom: Document feature unstable of @x-vfio-user-server, Markus Armbruster, 2024/07/17
- [PULL 10/14] docs/sphinx: add CSS styling for qmp-example directive, Markus Armbruster, 2024/07/17
- [PULL 09/14] docs/qapidoc: add QMP highlighting to annotated qmp-example blocks, Markus Armbruster, 2024/07/17
- [PULL 14/14] qapi: remove "Example" doc section, Markus Armbruster, 2024/07/17
- [PULL 07/14] docs/qapidoc: factor out do_parse(), Markus Armbruster, 2024/07/17
- [PULL 11/14] qapi: convert "Example" sections without titles, Markus Armbruster, 2024/07/17
- [PULL 13/14] qapi: convert "Example" sections with longer prose, Markus Armbruster, 2024/07/17
- [PULL 08/14] docs/qapidoc: create qmp-example directive, Markus Armbruster, 2024/07/17
- Re: [PULL 00/14] QAPI patches patches for 2024-07-17, Richard Henderson, 2024/07/18