aboutsummaryrefslogtreecommitdiff
path: root/qapi/sockets.json
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2023-04-28 12:54:29 +0200
committerMarkus Armbruster <armbru@redhat.com>2023-05-10 10:01:01 +0200
commita937b6aa739f65f2cae2ad9a7eb65a309ad2a359 (patch)
treec11a2c7b6fc5b850ef4dd6b613902759824779a5 /qapi/sockets.json
parent059d341a67bb660a7957cb62a6a860c92c2fb64a (diff)
downloadqemu-a937b6aa739f65f2cae2ad9a7eb65a309ad2a359.zip
qemu-a937b6aa739f65f2cae2ad9a7eb65a309ad2a359.tar.gz
qemu-a937b6aa739f65f2cae2ad9a7eb65a309ad2a359.tar.bz2
qapi: Reformat doc comments to conform to current conventions
Change # @name: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed # do eiusmod tempor incididunt ut labore et dolore magna aliqua. to # @name: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed # do eiusmod tempor incididunt ut labore et dolore magna aliqua. See recent commit "qapi: Relax doc string @name: description indentation rules" for rationale. Reflow paragraphs to 70 columns width, and consistently use two spaces to separate sentences. To check the generated documentation does not change, I compared the generated HTML before and after this commit with "wdiff -3". Finds no differences. Comparing with diff is not useful, as the reflown paragraphs are visible there. Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-Id: <20230428105429.1687850-18-armbru@redhat.com> Reviewed-by: Juan Quintela <quintela@redhat.com> Acked-by: Lukas Straub <lukasstraub2@web.de> [Straightforward conflicts in qapi/audio.json qapi/misc-target.json qapi/run-state.json resolved]
Diffstat (limited to 'qapi/sockets.json')
-rw-r--r--qapi/sockets.json50
1 files changed, 29 insertions, 21 deletions
diff --git a/qapi/sockets.json b/qapi/sockets.json
index bad74e3..6213154 100644
--- a/qapi/sockets.json
+++ b/qapi/sockets.json
@@ -41,21 +41,24 @@
##
# @InetSocketAddress:
#
-# Captures a socket address or address range in the Internet namespace.
+# Captures a socket address or address range in the Internet
+# namespace.
#
-# @numeric: true if the host/port are guaranteed to be numeric,
-# false if name resolution should be attempted. Defaults to false.
-# (Since 2.9)
+# @numeric: true if the host/port are guaranteed to be numeric, false
+# if name resolution should be attempted. Defaults to false.
+# (Since 2.9)
#
# @to: If present, this is range of possible addresses, with port
-# between @port and @to.
+# between @port and @to.
#
-# @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
+# @ipv4: whether to accept IPv4 addresses, default try both IPv4 and
+# IPv6
#
-# @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
+# @ipv6: whether to accept IPv6 addresses, default try both IPv4 and
+# IPv6
#
-# @keep-alive: enable keep-alive when connecting to this socket. Not supported
-# for passive sockets. (Since 4.2)
+# @keep-alive: enable keep-alive when connecting to this socket. Not
+# supported for passive sockets. (Since 4.2)
#
# @mptcp: enable multi-path TCP. (Since 6.1)
#
@@ -77,12 +80,14 @@
# Captures a socket address in the local ("Unix socket") namespace.
#
# @path: filesystem path to use
+#
# @abstract: if true, this is a Linux abstract socket address. @path
-# will be prefixed by a null byte, and optionally padded
-# with null bytes. Defaults to false. (Since 5.1)
+# will be prefixed by a null byte, and optionally padded with null
+# bytes. Defaults to false. (Since 5.1)
+#
# @tight: if false, pad an abstract socket address with enough null
-# bytes to make it fill struct sockaddr_un member sun_path.
-# Defaults to true. (Since 5.1)
+# bytes to make it fill struct sockaddr_un member sun_path.
+# Defaults to true. (Since 5.1)
#
# Since: 1.3
##
@@ -98,10 +103,11 @@
# Captures a socket address in the vsock namespace.
#
# @cid: unique host identifier
+#
# @port: port
#
# Note: string types are used to allow for possible future hostname or
-# service resolution support.
+# service resolution support.
#
# Since: 2.8
##
@@ -145,11 +151,12 @@
##
# @SocketAddressLegacy:
#
-# Captures the address of a socket, which could also be a named file descriptor
+# Captures the address of a socket, which could also be a named file
+# descriptor
#
# Note: This type is deprecated in favor of SocketAddress. The
-# difference between SocketAddressLegacy and SocketAddress is that the
-# latter has fewer {} on the wire.
+# difference between SocketAddressLegacy and SocketAddress is that
+# the latter has fewer {} on the wire.
#
# Since: 1.3
##
@@ -173,10 +180,11 @@
#
# @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: 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.
#
# Since: 2.9
##