From patchwork Thu Feb 13 17:56:44 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 183418 Delivered-To: patch@linaro.org Received: by 2002:a92:1f12:0:0:0:0:0 with SMTP id i18csp833532ile; Thu, 13 Feb 2020 10:09:50 -0800 (PST) X-Google-Smtp-Source: APXvYqzTziA5wQBiXNrgYrSJKnzlrOVBo1mqjvr2nJ1aHr4kL8Y/qyzO2WRgbZiv50rDUpm5YX4K X-Received: by 2002:a37:4b52:: with SMTP id y79mr17538808qka.389.1581617390604; Thu, 13 Feb 2020 10:09:50 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1581617390; cv=none; d=google.com; s=arc-20160816; b=rhbJ1KtPjX8N6agYgHKK+eBoy3pylQMrAeQvHAEyz9SCx3S62qvzcguvLAsvzTbWz/ JrmL8fF5lAAN76qfNqF9VgwmZP4YPLx8cLOPgHC0HP49NVJJhbtTZULRwmxBXCIAO7nm H9oR6KKwRQVDwRCubD/yPRPKLdtgcnQt5SM6FKZu8eMFhYBQ7qkF93+Aya+QTmfryQdy 1OaIvVS7Gj1d+67JRz/OkOUQ8vLMZC4fxKonUUYjcekHHAjzzYQfdC+PbPVAOUACCZ1G tjmE8JbXL1r3SuOq3MyyDk5OPJfmHH5l1OCaW57HPS4mQ4BFETlDhfeM1QXiGKnjSWO9 aejA== 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=0wlRVtRJhL4sdvkTCyYM1sERkCXT4sx5Lv57A2FYC0k=; b=lFMmFHYMQupatJhlDI6ZAXVddDg9dHcJWkkTYSe94WlJmQWH7kFrluzEwdwuAzNCnj 78kIJ3tsOfOtYfnqbQllSHJyVR1N0oLc9UVd8+Oq7Nv3uo+J3gLgt5b8B/qdogIF9XQu gcuraISE3nA0pJ2YYMT29HE1EL+nr9eOiwXwblrDkS3+jpWR3UpsLFrVG/kMlcsUo1pN UsKecYSNCqZNo6WfBgfZIqlb0kGPRUnZACp7PcI6J58pGpOQw06Gzbvu9KSIL+nIgxWz LHOfuGFcnvgIw3Qy/Vne9pus9VM6IoNMp27uhezN+LwQI/pRTo/pc4xX775c6fQ3SQaL kuVw== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=s0z6DGXx; 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 bp6si1220126qvb.141.2020.02.13.10.09.50 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Thu, 13 Feb 2020 10:09: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=s0z6DGXx; 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]:57374 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ivt-0001ml-VF for patch@linaro.org; Thu, 13 Feb 2020 13:09:49 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34662) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijz-00010Y-0B for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:33 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijx-0003QE-Oa for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:30 -0500 Received: from mail-wr1-x434.google.com ([2a00:1450:4864:20::434]:37695) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijx-0003Mb-Eb for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:29 -0500 Received: by mail-wr1-x434.google.com with SMTP id w15so7813900wru.4 for ; Thu, 13 Feb 2020 09:57:29 -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=0wlRVtRJhL4sdvkTCyYM1sERkCXT4sx5Lv57A2FYC0k=; b=s0z6DGXxQ+Q0n7fR9h+n2+o3MJX9auAuuc8UaKzrcJfGa7cJ9tdZ2aqNju8Zfft1LP N4LkE9m9xM6aUUVAKFpiN+CnKEhPW6wvo2D6e1RtZFrUv0AcTHejNG4M0c9GJmCJKqEJ Mex+NXoY+nWEkRtI0JLzEkk4T53PGaOAIq60FWevFKPrgpkIXNl1VDye1GaAyOeXJxgA zyeXYLz+ZW8liLfckXp5+STqRwr1zaN/bRAes4X+ivYR45GPtFP9JqAvirE/j7+9HlDV c4i8twuf9H2gK8l9w8TA6871cZnq6TUB0eURjyonurk+CT5lBaTbxk4k94Sd0D+FNCHt Rglw== 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=0wlRVtRJhL4sdvkTCyYM1sERkCXT4sx5Lv57A2FYC0k=; b=sQQtfdsCPEaG6cEk25JjFy763hHwlECJ8tHqnzHjdJHNfOMzfMWsphfCSBVE5AktHv FtWLK0IeDOJ3CfRvurLiqXnFzkqKZZLUHXn4CZTGS9cFs2DgUjaVmGgWJ+z8tzWksGqN aTlMSSLM7nhxcOmLODZhAvJgcfqw8nXKy2Z13jqflV7v+8iJqvIzIzhH7ZPCQeDFact6 r18ZHSsYQqFOB10hSI5BxrfFqrGFUokCVEUcPe2mYGhFkXHw6rEhZbql89vzBGZnq+PR kL1/2b2RiCCgoUdFU22YCuIirtko1/EdxI2uM1dx7d0LP3WLKer8dcOvmYRDCay85C+G Xc1Q== X-Gm-Message-State: APjAAAVqSDtm0lU2SPXxuF1jT/Qmv5vOisEQHEQBFZlXtTjC/VqIGajg vxKkLOSKZCv+N17ImGQfiDJRPRAGdzQ= X-Received: by 2002:adf:f1cb:: with SMTP id z11mr22059428wro.375.1581616647263; Thu, 13 Feb 2020 09:57:27 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:26 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 27/30] qapi: Use rST markup for literal blocks Date: Thu, 13 Feb 2020 17:56:44 +0000 Message-Id: <20200213175647.17628-28-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-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::434 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" There are exactly two places in our json doc comments where we use the markup accepted by the texi doc generator where a '|' in the first line of a doc comment means the line should be emitted as a literal block (fixed-width font, whitespace preserved). Since we use this syntax so rarely, instead of making the rST generator support it, instead just convert the two uses to rST-format literal blocks, which are indented and introduced with '::'. (The rST generator doesn't complain about the old style syntax, it just emits it with the '|' and with the whitespace not preserved, which looks odd, but means we can safely leave this change until after we've stopped generating texinfo.) Signed-off-by: Peter Maydell --- qapi/block-core.json | 16 +++++++++------- qapi/qapi-schema.json | 6 ++++-- 2 files changed, 13 insertions(+), 9 deletions(-) -- 2.20.1 diff --git a/qapi/block-core.json b/qapi/block-core.json index 13dad62f441..ea0371c33fb 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -550,13 +550,15 @@ # For the example above, @bins may be something like [3, 1, 5, 2], # and corresponding histogram looks like: # -# | 5| * -# | 4| * -# | 3| * * -# | 2| * * * -# | 1| * * * * -# | +------------------ -# | 10 50 100 +# :: +# +# 5| * +# 4| * +# 3| * * +# 2| * * * +# 1| * * * * +# +------------------ +# 10 50 100 # # Since: 4.0 ## diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json index f7ba60a5d0b..1d3fb573846 100644 --- a/qapi/qapi-schema.json +++ b/qapi/qapi-schema.json @@ -22,8 +22,10 @@ # # Example: # -# | -> data issued by the Client -# | <- Server data response +# :: +# +# -> data issued by the Client +# <- Server data response # # Please, refer to the QMP specification (docs/interop/qmp-spec.txt) for # detailed information on the Server command and response formats.