| Message ID | 20240711112228.2140606-5-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | qapi: Doc comment cleanups | expand |
On Thu, Jul 11, 2024, 7:22 AM Markus Armbruster <armbru@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 <armbru@redhat.com> > Reviewed-by: John Snow <jsnow@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 > >
On 11/7/24 13:22, Markus Armbruster 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. > > Signed-off-by: Markus Armbruster <armbru@redhat.com> > --- > qapi/sockets.json | 7 +++---- > 1 file changed, 3 insertions(+), 4 deletions(-) Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
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:
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(-)