[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 15/29] qapi/ui.json: Use explicit bulleted lists
From: |
Peter Maydell |
Subject: |
[PATCH 15/29] qapi/ui.json: Use explicit bulleted lists |
Date: |
Thu, 6 Feb 2020 17:30:26 +0000 |
A JSON block comment like this:
Returns: nothing on success
If @node is not a valid block device, DeviceNotFound
If @name is not found, GenericError with an explanation
renders in the HTML and manpage like this:
Returns: nothing on success If node is not a valid block device,
DeviceNotFound If name is not found, GenericError with an explanation
because whitespace is not significant.
Use an actual bulleted list, so that the formatting is correct.
Signed-off-by: Peter Maydell <address@hidden>
---
qapi/ui.json | 63 +++++++++++++++++++++++++++-------------------------
1 file changed, 33 insertions(+), 30 deletions(-)
diff --git a/qapi/ui.json b/qapi/ui.json
index 92d409c32c8..f527bbdc26e 100644
--- a/qapi/ui.json
+++ b/qapi/ui.json
@@ -12,8 +12,8 @@
#
# Sets the password of a remote display session.
#
-# @protocol: 'vnc' to modify the VNC server password
-# 'spice' to modify the Spice server password
+# @protocol: - 'vnc' to modify the VNC server password
+# - 'spice' to modify the Spice server password
#
# @password: the new password
#
@@ -23,8 +23,8 @@
# 'disconnect' to disconnect existing clients
# 'keep' to maintain existing clients
#
-# Returns: Nothing on success
-# If Spice is not enabled, DeviceNotFound
+# Returns: - Nothing on success
+# - If Spice is not enabled, DeviceNotFound
#
# Since: 0.14.0
#
@@ -46,13 +46,14 @@
# @protocol: the name of the remote display protocol 'vnc' or 'spice'
#
# @time: when to expire the password.
-# 'now' to expire the password immediately
-# 'never' to cancel password expiration
-# '+INT' where INT is the number of seconds from now (integer)
-# 'INT' where INT is the absolute time in seconds
#
-# Returns: Nothing on success
-# If @protocol is 'spice' and Spice is not active, DeviceNotFound
+# - 'now' to expire the password immediately
+# - 'never' to cancel password expiration
+# - '+INT' where INT is the number of seconds from now (integer)
+# - 'INT' where INT is the absolute time in seconds
+#
+# Returns: - Nothing on success
+# - If @protocol is 'spice' and Spice is not active, DeviceNotFound
#
# Since: 0.14.0
#
@@ -201,9 +202,10 @@
# @tls-port: The SPICE server's TLS port number.
#
# @auth: the current authentication type used by the server
-# 'none' if no authentication is being used
-# 'spice' uses SASL or direct TLS authentication, depending on command
-# line options
+#
+# - 'none' if no authentication is being used
+# - 'spice' uses SASL or direct TLS authentication, depending on command
+# line options
#
# @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
# be determined by the client or the server, or unknown if spice
@@ -433,27 +435,28 @@
# @host: The hostname the VNC server is bound to. This depends on
# the name resolution on the host and may be an IP address.
#
-# @family: 'ipv6' if the host is listening for IPv6 connections
-# 'ipv4' if the host is listening for IPv4 connections
-# 'unix' if the host is listening on a unix domain socket
-# 'unknown' otherwise
+# @family: - 'ipv6' if the host is listening for IPv6 connections
+# - 'ipv4' if the host is listening for IPv4 connections
+# - 'unix' if the host is listening on a unix domain socket
+# - 'unknown' otherwise
#
# @service: The service name of the server's port. This may depends
# on the host system's service database so symbolic names should not
# be relied on.
#
# @auth: the current authentication type used by the server
-# 'none' if no authentication is being used
-# 'vnc' if VNC authentication is being used
-# 'vencrypt+plain' if VEncrypt is used with plain text authentication
-# 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
-# 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
-# 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
-# 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
-# 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
-# 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text
auth
-# 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
-# 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
+#
+# - 'none' if no authentication is being used
+# - 'vnc' if VNC authentication is being used
+# - 'vencrypt+plain' if VEncrypt is used with plain text authentication
+# - 'vencrypt+tls+none' if VEncrypt is used with TLS and no
authentication
+# - 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC
authentication
+# - 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text
auth
+# - 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
+# - 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
+# - 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text
auth
+# - 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
+# - 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
#
# @clients: a list of @VncClientInfo of all currently connected clients
#
@@ -841,8 +844,8 @@
# @hold-time: time to delay key up events, milliseconds. Defaults
# to 100
#
-# Returns: Nothing on success
-# If key is unknown or redundant, InvalidParameter
+# Returns: - Nothing on success
+# - If key is unknown or redundant, InvalidParameter
#
# Since: 1.3.0
#
--
2.20.1
- Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments, (continued)
- [PATCH 11/29] qapi/ui.json: Put input-send-event body text in the right place, Peter Maydell, 2020/02/06
- [PATCH 13/29] qapi/ui.json: Avoid `...' texinfo style quoting, Peter Maydell, 2020/02/06
- [PATCH 12/29] qapi: Explicitly put "foo: dropped in n.n" notes into Notes section, Peter Maydell, 2020/02/06
- [PATCH 10/29] qapi: Remove hardcoded tabs, Peter Maydell, 2020/02/06
- [PATCH 15/29] qapi/ui.json: Use explicit bulleted lists,
Peter Maydell <=
- [PATCH 17/29] qapi: Add blank lines before bulleted lists, Peter Maydell, 2020/02/06
- [PATCH 18/29] qapi/migration.json: Replace _this_ with *this*, Peter Maydell, 2020/02/06
- [PATCH 20/29] qapi/machine.json: Escape a literal '*' in doc comment, Peter Maydell, 2020/02/06
- [PATCH 21/29] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/02/06
- [PATCH 14/29] qapi/block-core.json: Use explicit bulleted lists, Peter Maydell, 2020/02/06