[PATCH v2 29/33] qapi/ui.json: docs: 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 v2 29/33] qapi/ui.json: docs: 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/ui.json | 108 ++++++++++++++++++++++++++++++++-------------------
 1 file changed, 67 insertions(+), 41 deletions(-)

diff --git a/qapi/ui.json b/qapi/ui.json
index 1b2f4a4769..ab64c6372a 100644
--- a/qapi/ui.json
+++ b/qapi/ui.json
@@ -87,8 +87,8 @@
 #
 # .. qmp-example::
 #
-#     -> { "execute": "set_password", "arguments": { "protocol": "vnc",
-#                                                    "password": "secret" } }
+#     -> { "execute": "set_password",
+#          "arguments": { "protocol": "vnc", "password": "secret" } }
 #     <- { "return": {} }
 ##
 { 'command': 'set_password', 'boxed': true, 'data': 'SetPasswordOptions' }
@@ -149,8 +149,8 @@
 #
 # .. qmp-example::
 #
-#     -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
-#                                                       "time": "+60" } }
+#     -> { "execute": "expire_password",
+#          "arguments": { "protocol": "vnc", "time": "+60" } }
 #     <- { "return": {} }
 ##
 { 'command': 'expire_password', 'boxed': true, 'data': 'ExpirePasswordOptions' }
@@ -381,11 +381,14 @@
 #
 # .. qmp-example::
 #
-#     <- { "timestamp": {"seconds": 1290688046, "microseconds": 388707},
+#     <- { "timestamp": { "seconds": 1290688046,
+#                         "microseconds": 388707},
 #          "event": "SPICE_CONNECTED",
 #          "data": {
-#            "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"},
-#            "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
+#            "server": { "port": "5920", "family": "ipv4",
+#                        "host": "127.0.0.1" },
+#            "client": { "port": "52873", "family": "ipv4",
+#                        "host": "127.0.0.1" }
 #        }}
 ##
 { 'event': 'SPICE_CONNECTED',
@@ -407,13 +410,16 @@
 #
 # .. qmp-example::
 #
-#     <- { "timestamp": {"seconds": 1290688046, "microseconds": 417172},
+#     <- { "timestamp": {"seconds": 1290688046,
+#                        "microseconds": 417172},
 #          "event": "SPICE_INITIALIZED",
 #          "data": {"server": {"auth": "spice", "port": "5921",
 #                              "family": "ipv4", "host": "127.0.0.1"},
-#                   "client": {"port": "49004", "family": "ipv4", "channel-type": 3,
-#                              "connection-id": 1804289383, "host": "127.0.0.1",
-#                              "channel-id": 0, "tls": true}
+#                   "client": { "port": "49004", "family": "ipv4",
+#                               "channel-type": 3,
+#                               "connection-id": 1804289383,
+#                               "host": "127.0.0.1",
+#                               "channel-id": 0, "tls": true}
 #        }}
 ##
 { 'event': 'SPICE_INITIALIZED',
@@ -434,11 +440,14 @@
 #
 # .. qmp-example::
 #
-#     <- { "timestamp": {"seconds": 1290688046, "microseconds": 388707},
+#     <- { "timestamp": {"seconds": 1290688046,
+#                        "microseconds": 388707},
 #          "event": "SPICE_DISCONNECTED",
 #          "data": {
-#            "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"},
-#            "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
+#            "server": { "port": "5920", "family": "ipv4",
+#                        "host": "127.0.0.1"},
+#            "client": { "port": "52873", "family": "ipv4",
+#                        "host": "127.0.0.1"}
 #        }}
 ##
 { 'event': 'SPICE_DISCONNECTED',
@@ -455,7 +464,8 @@
 #
 # .. qmp-example::
 #
-#     <- { "timestamp": {"seconds": 1290688046, "microseconds": 417172},
+#     <- { "timestamp": {"seconds": 1290688046,
+#                        "microseconds": 417172},
 #          "event": "SPICE_MIGRATE_COMPLETED" }
 ##
 { 'event': 'SPICE_MIGRATE_COMPLETED',
@@ -727,11 +737,14 @@
 #
 #     <- { "event": "VNC_CONNECTED",
 #          "data": {
-#                "server": { "auth": "sasl", "family": "ipv4", "websocket": false,
+#                "server": { "auth": "sasl", "family": "ipv4",
+#                            "websocket": false,
 #                            "service": "5901", "host": "0.0.0.0" },
 #                "client": { "family": "ipv4", "service": "58425",
-#                            "host": "127.0.0.1", "websocket": false } },
-#          "timestamp": { "seconds": 1262976601, "microseconds": 975795 } }
+#                            "host": "127.0.0.1",
+#                            "websocket": false } },
+#          "timestamp": { "seconds": 1262976601,
+#                         "microseconds": 975795 } }
 ##
 { 'event': 'VNC_CONNECTED',
   'data': { 'server': 'VncServerInfo',
@@ -754,11 +767,15 @@
 #
 #     <-  { "event": "VNC_INITIALIZED",
 #           "data": {
-#                "server": { "auth": "sasl", "family": "ipv4", "websocket": false,
+#                "server": { "auth": "sasl", "family": "ipv4",
+#                            "websocket": false,
 #                            "service": "5901", "host": "0.0.0.0"},
-#                "client": { "family": "ipv4", "service": "46089", "websocket": false,
-#                            "host": "127.0.0.1", "sasl_username": "luiz" } },
-#           "timestamp": { "seconds": 1263475302, "microseconds": 150772 } }
+#                "client": { "family": "ipv4", "service": "46089",
+#                            "websocket": false,
+#                            "host": "127.0.0.1",
+#                            "sasl_username": "luiz" } },
+#           "timestamp": { "seconds": 1263475302,
+#                          "microseconds": 150772 } }
 ##
 { 'event': 'VNC_INITIALIZED',
   'data': { 'server': 'VncServerInfo',
@@ -780,11 +797,14 @@
 #
 #     <- { "event": "VNC_DISCONNECTED",
 #          "data": {
-#                "server": { "auth": "sasl", "family": "ipv4", "websocket": false,
-#                            "service": "5901", "host": "0.0.0.0" },
-#                "client": { "family": "ipv4", "service": "58425", "websocket": false,
-#                            "host": "127.0.0.1", "sasl_username": "luiz" } },
-#          "timestamp": { "seconds": 1262976601, "microseconds": 975795 } }
+#                "server": { "auth": "sasl", "family": "ipv4",
+#                            "websocket": false, "service": "5901",
+#                            "host": "0.0.0.0" },
+#                "client": { "family": "ipv4", "service": "58425",
+#                            "websocket": false, "host": "127.0.0.1",
+#                            "sasl_username": "luiz" } },
+#          "timestamp": { "seconds": 1262976601,
+#                         "microseconds": 975795 } }
 ##
 { 'event': 'VNC_DISCONNECTED',
   'data': { 'server': 'VncServerInfo',
@@ -1023,10 +1043,10 @@
 #
 # Send keys to guest.
 #
-# @keys: An array of `KeyValue` elements.  All @KeyValues in this array
-#     are simultaneously sent to the guest.  A `KeyValue`.number value
-#     is sent directly to the guest, while `KeyValue`.qcode must be a
-#     valid `QKeyCode` value
+# @keys: An array of `KeyValue` elements.  All @KeyValues in this
+#     array are simultaneously sent to the guest.  A `KeyValue`.number
+#     value is sent directly to the guest, while `KeyValue`.qcode must
+#     be a valid `QKeyCode` value
 #
 # @hold-time: time to delay key up events, milliseconds.  Defaults to
 #     100
@@ -1039,9 +1059,10 @@
 # .. qmp-example::
 #
 #     -> { "execute": "send-key",
-#          "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
-#                                   { "type": "qcode", "data": "alt" },
-#                                   { "type": "qcode", "data": "delete" } ] } }
+#          "arguments": { "keys": [
+#            { "type": "qcode", "data": "ctrl" },
+#            { "type": "qcode", "data": "alt" },
+#            { "type": "qcode", "data": "delete" } ] } }
 #     <- { "return": {} }
 ##
 { 'command': 'send-key',
@@ -1278,13 +1299,15 @@
 #     -> { "execute": "input-send-event",
 #         "arguments": { "device": "video0",
 #                        "events": [ { "type": "btn",
-#                        "data" : { "down": true, "button": "left" } } ] } }
+#                        "data" : { "down": true,
+#                                   "button": "left" } } ] } }
 #     <- { "return": {} }
 #
 #     -> { "execute": "input-send-event",
 #         "arguments": { "device": "video0",
 #                        "events": [ { "type": "btn",
-#                        "data" : { "down": false, "button": "left" } } ] } }
+#                        "data" : { "down": false,
+#                                   "button": "left" } } ] } }
 #     <- { "return": {} }
 #
 # .. qmp-example::
@@ -1305,8 +1328,10 @@
 #
 #     -> { "execute": "input-send-event" ,
 #       "arguments": { "events": [
-#                    { "type": "abs", "data" : { "axis": "x", "value" : 20000 } },
-#                    { "type": "abs", "data" : { "axis": "y", "value" : 400 } } ] } }
+#                    { "type": "abs",
+#                      "data" : { "axis": "x", "value" : 20000 } },
+#                    { "type": "abs",
+#                      "data" : { "axis": "y", "value" : 400 } } ] } }
 #     <- { "return": {} }
 ##
 { 'command': 'input-send-event',
@@ -1335,10 +1360,11 @@
 # @show-menubar: Display the main window menubar.  Defaults to "on".
 #     (Since 8.0)
 #
-# @keep-aspect-ratio: Keep width/height aspect ratio of guest content when
-#     resizing host window.  Defaults to "on". (Since 10.1)
+# @keep-aspect-ratio: Keep width/height aspect ratio of guest content
+#     when resizing host window.  Defaults to "on". (Since 10.1)
 #
-# @scale: Set preferred scale of the display.  Defaults to 1.0.  (Since 10.1)
+# @scale: Set preferred scale of the display.  Defaults to 1.0.
+#     (Since 10.1)
 #
 # Since: 2.12
 ##
-- 
2.48.1