qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Qemu-devel] [PATCH 03/36] qapi: add some line spacing to help doc parse


From: marcandre . lureau
Subject: [Qemu-devel] [PATCH 03/36] qapi: add some line spacing to help doc parser
Date: Fri, 25 Sep 2015 16:03:31 +0200

From: Marc-André Lureau <address@hidden>

Paragraphs are seperated by empty lines.

Signed-off-by: Marc-André Lureau <address@hidden>
---
 qapi-schema.json     | 14 ++++++++++++++
 qapi/block-core.json | 26 ++++++++++++++++++++++++++
 2 files changed, 40 insertions(+)

diff --git a/qapi-schema.json b/qapi-schema.json
index 3e2e53d..eb7beeb 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -856,8 +856,11 @@
 #        the name resolution on the host and may be an IP address.
 #
 # @family: #optional '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: #optional The service name of the server's port.  This may depends
@@ -865,16 +868,27 @@
 #           be relied on.
 #
 # @auth: #optional 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
 #
 # @clients: a list of @VncClientInfo of all currently connected clients
diff --git a/qapi/block-core.json b/qapi/block-core.json
index bb2189e..e458023 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -629,7 +629,9 @@
 # @password: the password to use for the device
 #
 # Returns: nothing on success
+#
 #          If @device is not a valid block device, DeviceNotFound
+#
 #          If @device is not encrypted, DeviceNotEncrypted
 #
 # Notes:  Not all block formats support encryption and some that do are not
@@ -655,6 +657,7 @@
 # @size:  new image size in bytes
 #
 # Returns: nothing on success
+#
 #          If @device is not a valid block device, DeviceNotFound
 #
 # Since: 0.14.0
@@ -792,6 +795,7 @@
 # For the arguments, see the documentation of BlockdevSnapshot.
 #
 # Returns: nothing on success
+#
 #          If @device is not a valid block device, DeviceNotFound
 #
 # Since 0.14.0
@@ -858,6 +862,7 @@
 #                           (Since 2.1)
 #
 #                    If top == base, that is an error.
+#
 #                    If top == active, the job will not be completed by itself,
 #                    user needs to complete the job with the block-job-complete
 #                    command after getting the ready event. (Since 2.0)
@@ -872,10 +877,15 @@
 # @speed:  #optional the maximum speed, in bytes per second
 #
 # Returns: Nothing on success
+#
 #          If commit or stream is already active on this device, DeviceInUse
+#
 #          If @device does not exist, DeviceNotFound
+#
 #          If image commit is not supported by this device, NotSupported
+#
 #          If @base or @top is invalid, a generic error is returned
+#
 #          If @speed is invalid, InvalidParameter
 #
 # Since: 1.3
@@ -897,6 +907,7 @@
 # For the arguments, see the documentation of DriveBackup.
 #
 # Returns: nothing on success
+#
 #          If @device is not a valid block device, DeviceNotFound
 #
 # Since 1.6
@@ -982,6 +993,7 @@
 #         Default is true. (Since 2.4)
 #
 # Returns: nothing on success
+#
 #          If @device is not a valid block device, DeviceNotFound
 #
 # Since 1.3
@@ -1028,7 +1040,9 @@
 # Create a dirty bitmap with a name on the node
 #
 # Returns: nothing on success
+#
 #          If @node is not a valid block device or node, DeviceNotFound
+#
 #          If @name is already taken, GenericError with an explanation
 #
 # Since 2.4
@@ -1042,8 +1056,11 @@
 # Remove a dirty bitmap on the node
 #
 # Returns: nothing on success
+#
 #          If @node is not a valid block device or node, DeviceNotFound
+#
 #          If @name is not found, GenericError with an explanation
+#
 #          if @name is frozen by an operation, GenericError
 #
 # Since 2.4
@@ -1057,7 +1074,9 @@
 # Clear (reset) a dirty bitmap on the device
 #
 # Returns: nothing on success
+#
 #          If @node is not a valid block device, DeviceNotFound
+#
 #          If @name is not found, GenericError with an explanation
 #
 # Since 2.4
@@ -1122,6 +1141,7 @@
 # @group: #optional throttle group name (Since 2.4)
 #
 # Returns: Nothing on success
+#
 #          If @device is not a valid block device, DeviceNotFound
 #
 # Since: 1.1
@@ -1179,6 +1199,7 @@
 #            supports io-status (see BlockInfo).  Since 1.3.
 #
 # Returns: Nothing on success
+#
 #          If @device does not exist, DeviceNotFound
 #
 # Since: 1.1
@@ -1202,6 +1223,7 @@
 #          Defaults to 0.
 #
 # Returns: Nothing on success
+#
 #          If no background operation is active on this device, DeviceNotActive
 #
 # Since: 1.1
@@ -1233,6 +1255,7 @@
 #         false).  Since 1.3.
 #
 # Returns: Nothing on success
+#
 #          If no background operation is active on this device, DeviceNotActive
 #
 # Since: 1.1
@@ -1256,6 +1279,7 @@
 # @device: the device name
 #
 # Returns: Nothing on success
+#
 #          If no background operation is active on this device, DeviceNotActive
 #
 # Since: 1.3
@@ -1276,6 +1300,7 @@
 # @device: the device name
 #
 # Returns: Nothing on success
+#
 #          If no background operation is active on this device, DeviceNotActive
 #
 # Since: 1.3
@@ -1302,6 +1327,7 @@
 # @device: the device name
 #
 # Returns: Nothing on success
+#
 #          If no background operation is active on this device, DeviceNotActive
 #
 # Since: 1.3
-- 
2.4.3




reply via email to

[Prev in Thread] Current Thread [Next in Thread]