diff options
author | Markus Armbruster <armbru@redhat.com> | 2024-07-11 13:22:27 +0200 |
---|---|---|
committer | Markus Armbruster <armbru@redhat.com> | 2024-07-17 10:15:04 +0200 |
commit | 6cab0537926bafbb6be2fc93202611fa5113219b (patch) | |
tree | f472b241c4dc2e2b97dbddbdadccc294675f49fd | |
parent | dd950220c08938e14abb0357107ca8500cb913c9 (diff) | |
download | qemu-6cab0537926bafbb6be2fc93202611fa5113219b.zip qemu-6cab0537926bafbb6be2fc93202611fa5113219b.tar.gz qemu-6cab0537926bafbb6be2fc93202611fa5113219b.tar.bz2 |
qapi/sockets: Move deprecation note out of SocketAddress doc comment
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>
-rw-r--r-- | qapi/sockets.json | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/qapi/sockets.json b/qapi/sockets.json index 4d78d2c..e76fdb9 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: |