On Thu, Jul 11, 2024, 7:22 AM Markus Armbruster <arm...@redhat.com> wrote:
> 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.
>
Sure.
> Signed-off-by: Markus Armbruster <arm...@redhat.com>
>
Reviewed-by: John Snow <js...@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
>
>
