[PATCH 18/33] qapi/net.json: reflow docs to width=70 and two spaces between sentences

Vladimir Sementsov-Ogievskiy posted 33 patches 1 month ago
Maintainers: Eric Blake <eblake@redhat.com>, Markus Armbruster <armbru@redhat.com>, Mauro Carvalho Chehab <mchehab+huawei@kernel.org>, "Michael S. Tsirkin" <mst@redhat.com>, Igor Mammedov <imammedo@redhat.com>, Ani Sinha <anisinha@redhat.com>, Gerd Hoffmann <kraxel@redhat.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, Kevin Wolf <kwolf@redhat.com>, Hanna Reitz <hreitz@redhat.com>, Paolo Bonzini <pbonzini@redhat.com>, "Daniel P. Berrangé" <berrange@redhat.com>, John Snow <jsnow@redhat.com>, Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>, Eduardo Habkost <eduardo@habkost.net>, Marcel Apfelbaum <marcel.apfelbaum@gmail.com>, "Philippe Mathieu-Daudé" <philmd@linaro.org>, Yanan Wang <wangyanan55@huawei.com>, Zhao Liu <zhao1.liu@intel.com>, Peter Xu <peterx@redhat.com>, Fabiano Rosas <farosas@suse.de>, Jason Wang <jasowang@redhat.com>, "Alex Bennée" <alex.bennee@linaro.org>, Jiri Pirko <jiri@resnulli.us>, Stefan Berger <stefanb@linux.vnet.ibm.com>, Stefan Hajnoczi <stefanha@redhat.com>, Mads Ynddal <mads@ynddal.dk>, Alex Williamson <alex.williamson@redhat.com>, "Cédric Le Goater" <clg@redhat.com>, Michael Roth <michael.roth@amd.com>, Kostiantyn Kostiuk <kkostiuk@redhat.com>
There is a newer version of this series
[PATCH 18/33] qapi/net.json: reflow docs to width=70 and two spaces between sentences
Posted by Vladimir Sementsov-Ogievskiy 1 month ago
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
---
 qapi/net.json | 61 ++++++++++++++++++++++++++++++++-------------------
 1 file changed, 38 insertions(+), 23 deletions(-)

diff --git a/qapi/net.json b/qapi/net.json
index 60d196afe5..834a9abb9d 100644
--- a/qapi/net.json
+++ b/qapi/net.json
@@ -51,8 +51,9 @@
 # .. qmp-example::
 #
 #     -> { "execute": "netdev_add",
-#          "arguments": { "type": "user", "id": "netdev1",
-#                         "dnssearch": [ { "str": "example.org" } ] } }
+#          "arguments": {
+#            "type": "user", "id": "netdev1",
+#            "dnssearch": [ { "str": "example.org" } ] } }
 #     <- { "return": {} }
 ##
 { 'command': 'netdev_add', 'data': 'Netdev', 'boxed': true,
@@ -119,9 +120,11 @@
 #
 # Unprivileged user-mode network connectivity using passt
 #
-# @path: Filename of the passt program to run (by default 'passt', and use PATH)
+# @path: Filename of the passt program to run (by default 'passt',
+#     and use PATH)
 #
-# @quiet: don't print informational messages (default, passed as '--quiet')
+# @quiet: don't print informational messages
+#    (default, passed as '--quiet')
 #
 # @vhost-user: enable vhost-user
 #
@@ -281,8 +284,8 @@
 #
 # @smbserver: IP address of the built-in SMB server
 #
-# @hostfwd: redirect incoming TCP, UDP or UNIX host connections to guest
-#     endpoints
+# @hostfwd: redirect incoming TCP, UDP or UNIX host connections to
+#     guest endpoints
 #
 # @guestfwd: forward guest TCP connections
 #
@@ -569,7 +572,8 @@
 #     (default: 0).
 #
 # @inhibit: Don't load a default XDP program, use one already loaded
-#     to the interface (default: false).  Requires @sock-fds or @map-path.
+#     to the interface (default: false).  Requires @sock-fds or
+#     @map-path.
 #
 # @sock-fds: A colon (:) separated list of file descriptors for
 #     already open but not bound AF_XDP sockets in the queue order.
@@ -582,7 +586,8 @@
 #     mutually exclusive.  Requires @inhibit.  (Since 10.1)
 #
 # @map-start-index: Use @map-path to insert xsk sockets starting from
-#     this index number (default: 0).  Requires @map-path.  (Since 10.1)
+#     this index number (default: 0).  Requires @map-path.
+#     (Since 10.1)
 #
 # Since: 8.2
 ##
@@ -774,10 +779,10 @@
 #     attempt a reconnect after the given number of seconds.  Setting
 #     this to zero disables this function.  (default: 0) (since 8.0)
 #
-# @reconnect-ms: For a client socket, if a socket is disconnected, then
-#     attempt a reconnect after the given number of milliseconds.  Setting
-#     this to zero disables this function.  This member is mutually
-#     exclusive with @reconnect.  (default: 0) (Since: 9.2)
+# @reconnect-ms: For a client socket, if a socket is disconnected,
+#     then attempt a reconnect after the given number of milliseconds.
+#     Setting this to zero disables this function.  This member is
+#     mutually exclusive with @reconnect.  (default: 0) (Since: 9.2)
 #
 # Only `SocketAddress` types 'unix', 'inet' and 'fd' are supported.
 #
@@ -985,7 +990,8 @@
 #
 # .. qmp-example::
 #
-#     -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
+#     -> { "execute": "query-rx-filter",
+#          "arguments": { "name": "vnet0" } }
 #     <- { "return": [
 #             {
 #                 "promiscuous": true,
@@ -1031,9 +1037,11 @@
 # .. qmp-example::
 #
 #     <- { "event": "NIC_RX_FILTER_CHANGED",
-#          "data": { "name": "vnet0",
-#                    "path": "/machine/peripheral/vnet0/virtio-backend" },
-#          "timestamp": { "seconds": 1368697518, "microseconds": 326866 } }
+#          "data": {
+#            "name": "vnet0",
+#            "path": "/machine/peripheral/vnet0/virtio-backend" },
+#          "timestamp": { "seconds": 1368697518,
+#                         "microseconds": 326866 } }
 ##
 { 'event': 'NIC_RX_FILTER_CHANGED',
   'data': { '*name': 'str', 'path': 'str' } }
@@ -1108,7 +1116,8 @@
 #
 #     <- { "event": "FAILOVER_NEGOTIATED",
 #          "data": { "device-id": "net1" },
-#          "timestamp": { "seconds": 1368697518, "microseconds": 326866 } }
+#          "timestamp": { "seconds": 1368697518,
+#                         "microseconds": 326866 } }
 ##
 { 'event': 'FAILOVER_NEGOTIATED',
   'data': {'device-id': 'str'} }
@@ -1130,14 +1139,17 @@
 #          "data": { "netdev-id": "netdev0",
 #                    "addr": { "port": "47666", "ipv6": true,
 #                              "host": "::1", "type": "inet" } },
-#          "timestamp": { "seconds": 1666269863, "microseconds": 311222 } }
+#          "timestamp": { "seconds": 1666269863,
+#                         "microseconds": 311222 } }
 #
 # .. qmp-example::
 #
 #     <- { "event": "NETDEV_STREAM_CONNECTED",
 #          "data": { "netdev-id": "netdev0",
-#                    "addr": { "path": "/tmp/qemu0", "type": "unix" } },
-#          "timestamp": { "seconds": 1666269706, "microseconds": 413651 } }
+#                    "addr": { "path": "/tmp/qemu0",
+#                              "type": "unix" } },
+#          "timestamp": { "seconds": 1666269706,
+#                         "microseconds": 413651 } }
 ##
 { 'event': 'NETDEV_STREAM_CONNECTED',
   'data': { 'netdev-id': 'str',
@@ -1156,7 +1168,8 @@
 #
 #     <- { "event": "NETDEV_STREAM_DISCONNECTED",
 #          "data": {"netdev-id": "netdev0"},
-#          "timestamp": {"seconds": 1663330937, "microseconds": 526695} }
+#          "timestamp": {"seconds": 1663330937,
+#                        "microseconds": 526695} }
 ##
 { 'event': 'NETDEV_STREAM_DISCONNECTED',
   'data': { 'netdev-id': 'str' } }
@@ -1174,7 +1187,8 @@
 #
 # .. qmp-example::
 #
-#     <- { "timestamp": {"seconds": 1739538638, "microseconds": 354181 },
+#     <- { "timestamp": {"seconds": 1739538638,
+#                        "microseconds": 354181 },
 #          "event": "NETDEV_VHOST_USER_CONNECTED",
 #          "data": { "netdev-id": "netdev0", "chardev-id": "chr0" } }
 #
@@ -1193,7 +1207,8 @@
 #
 # .. qmp-example::
 #
-#     <- { "timestamp": { "seconds": 1739538634, "microseconds": 920450 },
+#     <- { "timestamp": { "seconds": 1739538634,
+#                         "microseconds": 920450 },
 #          "event": "NETDEV_VHOST_USER_DISCONNECTED",
 #          "data": { "netdev-id": "netdev0" } }
 #
-- 
2.48.1