From patchwork Thu Feb 6 17:30:25 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 183114 Delivered-To: patch@linaro.org Received: by 2002:a92:1f12:0:0:0:0:0 with SMTP id i18csp1840506ile; Thu, 6 Feb 2020 09:40:50 -0800 (PST) X-Google-Smtp-Source: APXvYqyVV/ZYOrRbSEABM4d2OUxdYzGl/GTNqExBHLoJSthnFnLcDIoQK1xkAaeGxv0c3mmAHIkg X-Received: by 2002:a37:8e03:: with SMTP id q3mr3465267qkd.395.1581010850885; Thu, 06 Feb 2020 09:40:50 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1581010850; cv=none; d=google.com; s=arc-20160816; b=s9oobxxToYi+6OBzqo8wynZJE5xhvi5fAyiiO3oYZuhEI51DqU04UAH5gptOEYdCpd pK2D72/ko8WrW6WopmWSBNXrMOhyiDRlEV40iDcfZzXqdfnMkmINyWV3bcHRs0VFegwc 0WJUiRtONBl87EFdqZhnxUEg65yo1K9uQS/fcqMo/hfg51cqbVq7ShxOrOyTYBoL05V4 +lVDsB0qK9ZnAgVfhD3E8MFxjnRyYNrXS1quxgWhdInp+WpugyXzvHTJ1Y3jMpWTms6B 4b1qWZCUcoXj/6yoAfRAG3vXdq5g0HKlolH2yFaPHzMlJwT9Hxa1lRSzDYeOGzwKYy6f 2EvA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:to:from :dkim-signature; bh=nZ0b4zym0no5ijQS0lkSAYODxVV1330DBhgaT3Ed+mE=; b=AVsGRr6H+UwvMKNVUo06xPKAC6qRIVJSQOz/DETZaJWk8a6r/RK/vb1RLFh83TYz3f fnTpmILWpg4ehSeSqOh9FQpCP0DRMWGENd7L7czTE7xC/+YM1yCoDG+ODGBIxnS73Wsp oEyc6wScwjjvDgZ1pkGMbLu5IstDNYNW8+Mk+B9NPhYYHVb7/3NfH6UgwJ1+WPBCD2J2 +bO4Lr5aU3w4pAB2hvDfEczS5qT8AiCmtc69YqW/wlpLAvBPnyOhj7q0XGkZQbnEdzjp 55mcHofcBmhBFER0wDpIdXffHVbgi6eIu+rW3uO5G0Wca3hUy+IcyhhDJENPw6IqNUof jHBQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=yPAveYaI; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id f15si57234qte.338.2020.02.06.09.40.50 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Thu, 06 Feb 2020 09:40:50 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=yPAveYaI; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1]:43536 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1izl90-0004pR-D9 for patch@linaro.org; Thu, 06 Feb 2020 12:40:50 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:43484) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1izkzt-0006jq-7Y for qemu-devel@nongnu.org; Thu, 06 Feb 2020 12:31:27 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1izkzr-00061X-2s for qemu-devel@nongnu.org; Thu, 06 Feb 2020 12:31:25 -0500 Received: from mail-wm1-x335.google.com ([2a00:1450:4864:20::335]:53741) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1izkzq-0005xJ-PZ for qemu-devel@nongnu.org; Thu, 06 Feb 2020 12:31:22 -0500 Received: by mail-wm1-x335.google.com with SMTP id s10so881402wmh.3 for ; Thu, 06 Feb 2020 09:31:22 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=nZ0b4zym0no5ijQS0lkSAYODxVV1330DBhgaT3Ed+mE=; b=yPAveYaIYMNLRnQpXSNl/bGS8E56iiM2YhzA8Z5NsKLJeqJ/HfHIehlH/vPvDZLWKl rdAL6xqwT6jLL55+lLLQ+VLtj0p1MY/npaDikF39r3K2l9grGcrnNk2+z7+Lu6YKDw60 EZCfqnbf4E2VuKit0sPGolIeOk8sup36zMV5Cl3OUHAvQywMh6A8+TLLounTafE8aKDb rQR5Ttf/1a/WbMOy8C9rKVYQFAaNWeyJvnZmplH2aOomX9LK+PrDFKGmDkTA7/CzthDA 8pbFPODs+J0Ye4j4n3NdpDmYDBQvZiOVuWgpgjuiPQd4GpFCeLSpDI76cV1mbEW99Oh4 4w/A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=nZ0b4zym0no5ijQS0lkSAYODxVV1330DBhgaT3Ed+mE=; b=IywD4JY8Iiq/T44YULaUT5u+ojULDLqVepz9us07FP3eLHp40e8gjh5kXsoaSQRyZT pGkaCicCLnM1NXqY5Dd9N545nI/f/v9VV2+fzccmpOzrrBqUfdjLLyBBY421op6pjFi5 F6Yko/voSHQdB5lwPSjoOGW9gbGZhEmfX1Ig0lYTLCPeIywYXp369OklEqUSS1Te5EAp abA01+g4uVmofbtFm6mrFfHFENz6jrJ696P52DLGV0UHEPXQMzESUweabjET2YCD9mJY MF3tL7JbGbQr25LFDtcnnO6Yih+7tsiTjIHc4MMOBpqcFnp6Ly4TaLKrPZImrtsorgcD buQg== X-Gm-Message-State: APjAAAXFiSRgPu9KmbCpjcAvuVskEDx+wGJKErvc++Q10TNKSetllPOz 8n+7ekKx8fyl1FqQPZcZoaDiGotTx9s= X-Received: by 2002:a05:600c:2207:: with SMTP id z7mr5784425wml.138.1581010281046; Thu, 06 Feb 2020 09:31:21 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id w15sm5204214wrs.80.2020.02.06.09.31.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 06 Feb 2020 09:31:20 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH 14/29] qapi/block-core.json: Use explicit bulleted lists Date: Thu, 6 Feb 2020 17:30:25 +0000 Message-Id: <20200206173040.17337-15-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200206173040.17337-1-peter.maydell@linaro.org> References: <20200206173040.17337-1-peter.maydell@linaro.org> MIME-Version: 1.0 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::335 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" 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 --- qapi/block-core.json | 108 +++++++++++++++++++++---------------------- 1 file changed, 54 insertions(+), 54 deletions(-) -- 2.20.1 Reviewed-by: Markus Armbruster diff --git a/qapi/block-core.json b/qapi/block-core.json index 6cc8a4f73e0..9e878e39336 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -1326,8 +1326,8 @@ # # @size: new image size in bytes # -# Returns: nothing on success -# If @device is not a valid block device, DeviceNotFound +# Returns: - nothing on success +# - If @device is not a valid block device, DeviceNotFound # # Since: 0.14.0 # @@ -1510,8 +1510,8 @@ # # For the arguments, see the documentation of BlockdevSnapshotSync. # -# Returns: nothing on success -# If @device is not a valid block device, DeviceNotFound +# Returns: - nothing on success +# - If @device is not a valid block device, DeviceNotFound # # Since: 0.14.0 # @@ -1586,9 +1586,8 @@ # when specifying the string or the image chain may # not be able to be reopened again. # -# Returns: Nothing on success -# -# If "device" does not exist or cannot be determined, DeviceNotFound +# Returns: - Nothing on success +# - If "device" does not exist or cannot be determined, DeviceNotFound # # Since: 2.1 ## @@ -1674,9 +1673,9 @@ # list without user intervention. # Defaults to true. (Since 3.1) # -# Returns: Nothing on success -# If @device does not exist, DeviceNotFound -# Any other error returns a GenericError. +# Returns: - Nothing on success +# - If @device does not exist, DeviceNotFound +# - Any other error returns a GenericError. # # Since: 1.3 # @@ -1704,8 +1703,8 @@ # The operation can be stopped before it has completed using the # block-job-cancel command. # -# Returns: nothing on success -# If @device is not a valid block device, GenericError +# Returns: - nothing on success +# - If @device is not a valid block device, GenericError # # Since: 1.6 # @@ -1730,8 +1729,8 @@ # The operation can be stopped before it has completed using the # block-job-cancel command. # -# Returns: nothing on success -# If @device is not a valid block device, DeviceNotFound +# Returns: - nothing on success +# - If @device is not a valid block device, DeviceNotFound # # Since: 2.3 # @@ -1925,8 +1924,8 @@ # format of the mirror image, default is to probe if mode='existing', # else the format of the source. # -# Returns: nothing on success -# If @device is not a valid block device, GenericError +# Returns: - nothing on success +# - If @device is not a valid block device, GenericError # # Since: 1.3 # @@ -2097,9 +2096,9 @@ # # Create a dirty bitmap with a name on the node, and start tracking the writes. # -# Returns: nothing on success -# If @node is not a valid block device or node, DeviceNotFound -# If @name is already taken, GenericError with an explanation +# 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 # @@ -2120,10 +2119,10 @@ # with block-dirty-bitmap-add. If the bitmap is persistent, remove it from its # storage too. # -# 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 +# 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 # @@ -2144,9 +2143,9 @@ # backup from this point in time forward will only backup clusters # modified after this clear operation. # -# Returns: nothing on success -# If @node is not a valid block device, DeviceNotFound -# If @name is not found, GenericError with an explanation +# 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 # @@ -2165,9 +2164,9 @@ # # Enables a dirty bitmap so that it will begin tracking disk changes. # -# Returns: nothing on success -# If @node is not a valid block device, DeviceNotFound -# If @name is not found, GenericError with an explanation +# Returns: - nothing on success +# - If @node is not a valid block device, DeviceNotFound +# - If @name is not found, GenericError with an explanation # # Since: 4.0 # @@ -2186,9 +2185,9 @@ # # Disables a dirty bitmap so that it will stop tracking disk changes. # -# Returns: nothing on success -# If @node is not a valid block device, DeviceNotFound -# If @name is not found, GenericError with an explanation +# Returns: - nothing on success +# - If @node is not a valid block device, DeviceNotFound +# - If @name is not found, GenericError with an explanation # # Since: 4.0 # @@ -2215,11 +2214,11 @@ # of the source bitmaps. This can be used to achieve backup checkpoints, or in # simpler usages, to copy bitmaps. # -# Returns: nothing on success -# If @node is not a valid block device, DeviceNotFound -# If any bitmap in @bitmaps or @target is not found, GenericError -# If any of the bitmaps have different sizes or granularities, -# GenericError +# Returns: - nothing on success +# - If @node is not a valid block device, DeviceNotFound +# - If any bitmap in @bitmaps or @target is not found, GenericError +# - If any of the bitmaps have different sizes or granularities, +# GenericError # # Since: 4.0 # @@ -2251,10 +2250,10 @@ # # Get bitmap SHA256. # -# Returns: BlockDirtyBitmapSha256 on success -# If @node is not a valid block device, DeviceNotFound -# If @name is not found or if hashing has failed, GenericError with an -# explanation +# Returns: - BlockDirtyBitmapSha256 on success +# - If @node is not a valid block device, DeviceNotFound +# - If @name is not found or if hashing has failed, GenericError with an +# explanation # # Since: 2.10 ## @@ -2371,8 +2370,8 @@ # the device will be removed from its group and the rest of its # members will not be affected. The 'group' parameter is ignored. # -# Returns: Nothing on success -# If @device is not a valid block device, DeviceNotFound +# Returns: - Nothing on success +# - If @device is not a valid block device, DeviceNotFound # # Since: 1.1 # @@ -2622,7 +2621,8 @@ # list without user intervention. # Defaults to true. (Since 3.1) # -# Returns: Nothing on success. If @device does not exist, DeviceNotFound. +# Returns: - Nothing on success. +# - If @device does not exist, DeviceNotFound. # # Since: 1.1 # @@ -2656,8 +2656,8 @@ # @speed: the maximum speed, in bytes per second, or 0 for unlimited. # Defaults to 0. # -# Returns: Nothing on success -# If no background operation is active on this device, DeviceNotActive +# Returns: - Nothing on success +# - If no background operation is active on this device, DeviceNotActive # # Since: 1.1 ## @@ -2696,8 +2696,8 @@ # abandon the job immediately (even if it is paused) instead of waiting # for the destination to complete its final synchronization (since 1.3) # -# Returns: Nothing on success -# If no background operation is active on this device, DeviceNotActive +# Returns: - Nothing on success +# - If no background operation is active on this device, DeviceNotActive # # Since: 1.1 ## @@ -2720,8 +2720,8 @@ # the name of the parameter), but since QEMU 2.7 it can have # other values. # -# Returns: Nothing on success -# If no background operation is active on this device, DeviceNotActive +# Returns: - Nothing on success +# - If no background operation is active on this device, DeviceNotActive # # Since: 1.3 ## @@ -2742,8 +2742,8 @@ # the name of the parameter), but since QEMU 2.7 it can have # other values. # -# Returns: Nothing on success -# If no background operation is active on this device, DeviceNotActive +# Returns: - Nothing on success +# - If no background operation is active on this device, DeviceNotActive # # Since: 1.3 ## @@ -2770,8 +2770,8 @@ # the name of the parameter), but since QEMU 2.7 it can have # other values. # -# Returns: Nothing on success -# If no background operation is active on this device, DeviceNotActive +# Returns: - Nothing on success +# - If no background operation is active on this device, DeviceNotActive # # Since: 1.3 ##