From patchwork Fri Sep 25 14:03:31 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Marc-Andr=C3=A9_Lureau?= X-Patchwork-Id: 522813 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [IPv6:2001:4830:134:3::11]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 2143C140788 for ; Sat, 26 Sep 2015 00:05:03 +1000 (AEST) Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b=LlcxK6nI; dkim-atps=neutral Received: from localhost ([::1]:41851 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZfTcS-0007fJ-TI for incoming@patchwork.ozlabs.org; Fri, 25 Sep 2015 10:05:00 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:41468) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZfTbh-00069u-H5 for qemu-devel@nongnu.org; Fri, 25 Sep 2015 10:04:14 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZfTbg-0003HT-7T for qemu-devel@nongnu.org; Fri, 25 Sep 2015 10:04:13 -0400 Received: from mail-wi0-x22e.google.com ([2a00:1450:400c:c05::22e]:37717) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZfTbf-0003Gt-U9 for qemu-devel@nongnu.org; Fri, 25 Sep 2015 10:04:12 -0400 Received: by wicfx3 with SMTP id fx3so21014557wic.0 for ; Fri, 25 Sep 2015 07:04:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-type:content-transfer-encoding; bh=p3h5yFvdxm9LXLCuaN3VQtaHXNpx3UJLUL2OB6t/qGg=; b=LlcxK6nIdFIVKLzNl8Y0uzdqp7bgcAR6MADMqa6Zn7Ug2fqe4cUZsGWu986Ld6b7VQ nWoNbhJvgaQd0cJ00U7rODuFsx9OhloeSKbu4Ia3N+TPkSBW97PuHg0aEWp8KI1i7zWx m1cBROLh0wxb62lG0198iw4juxylgQ/ICK0hup/7fmwMaPKIJsfirP0pW91BaqxQL1QT GOsC/7SjL1x9z0qRKch32sJN08XTAXKYOLS+MnwunLiFsHcgekKgiquh4gNh4ZV6HthW HmBlXIz15B7HdYEO3JErXa/4RQM5oBckCbLapYJCDHvaDAwGdjP5XvKS9npS/zM9Tw86 iX4Q== X-Received: by 10.180.23.67 with SMTP id k3mr3692619wif.78.1443189850287; Fri, 25 Sep 2015 07:04:10 -0700 (PDT) Received: from localhost ([149.6.167.210]) by smtp.gmail.com with ESMTPSA id ki7sm3519610wjc.28.2015.09.25.07.04.09 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 25 Sep 2015 07:04:09 -0700 (PDT) From: marcandre.lureau@redhat.com To: qemu-devel@nongnu.org Date: Fri, 25 Sep 2015 16:03:31 +0200 Message-Id: <1443189844-20341-4-git-send-email-marcandre.lureau@redhat.com> X-Mailer: git-send-email 2.4.3 In-Reply-To: <1443189844-20341-1-git-send-email-marcandre.lureau@redhat.com> References: <1443189844-20341-1-git-send-email-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Received-From: 2a00:1450:400c:c05::22e Cc: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , armbru@redhat.com, mdroth@linux.vnet.ibm.com Subject: [Qemu-devel] [PATCH 03/36] qapi: add some line spacing to help doc parser X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org From: Marc-André Lureau Paragraphs are seperated by empty lines. Signed-off-by: Marc-André Lureau --- 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