motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-08-03 07:43:54 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

qapi: Improve documentation of file descriptor socket addresses

Browse source 
SocketAddress branch @fd is documented in enum SocketAddressType,
unlike the other branches.  That's because the branch's type is String
from common.json.

Use a local copy of String, so we can put the documentation in the
usual place.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-14-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Markus Armbruster 2024-02-05 08:47:07 +01:00
parent 2fecccbc84
commit 4edb196e20
4 changed files with 31 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

40
qapi/sockets.json
View file

@ -5,8 +5,6 @@
# = Socket data types
##
{ 'include': 'common.json' }
##
# @NetworkAddressFamily:
#
@ -116,6 +114,24 @@
'cid': 'str',
'port': 'str' } }
##
# @FdSocketAddress:
#
# A file descriptor name or number.
#
# @str: decimal is for file descriptor number, otherwise it's a file
# descriptor name. Named file descriptors are permitted in
# monitor commands, in combination with the 'getfd' command.
# Decimal file descriptors are permitted at startup or other
# contexts where no monitor context is active.
#
#
# Since: 1.2
##
{ 'struct': 'FdSocketAddress',
'data': {
'str': 'str' } }
##
# @InetSocketAddressWrapper:
#
@ -147,12 +163,14 @@
'data': { 'data': 'VsockSocketAddress' } }
##
# @StringWrapper:
# @FdSocketAddressWrapper:
#
# @data: file descriptor name or number
#
# Since: 1.3
##
{ 'struct': 'StringWrapper',
'data': { 'data': 'String' } }
{ 'struct': 'FdSocketAddressWrapper',
'data': { 'data': 'FdSocketAddress' } }
##
# @SocketAddressLegacy:
@ -173,7 +191,7 @@
'inet': 'InetSocketAddressWrapper',
'unix': 'UnixSocketAddressWrapper',
'vsock': 'VsockSocketAddressWrapper',
'fd': 'StringWrapper' } }
'fd': 'FdSocketAddressWrapper' } }
##
# @SocketAddressType:
@ -186,11 +204,7 @@
#
# @vsock: VMCI address
#
# @fd: decimal is for file descriptor number, otherwise a file
# descriptor name. Named file descriptors are permitted in
# monitor commands, in combination with the 'getfd' command.
# Decimal file descriptors are permitted at startup or other
# contexts where no monitor context is active.
# @fd: Socket file descriptor
#
# Since: 2.9
##
@ -200,7 +214,7 @@
##
# @SocketAddress:
#
# Captures the address of a socket, which could also be a named file
# Captures the address of a socket, which could also be a socket file
# descriptor
#
# @type: Transport type
@ -213,4 +227,4 @@
'data': { 'inet': 'InetSocketAddress',
'unix': 'UnixSocketAddress',
'vsock': 'VsockSocketAddress',
'fd': 'String' } }
'fd': 'FdSocketAddress' } }