From patchwork Thu Feb 6 17:30:37 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 183125 Delivered-To: patch@linaro.org Received: by 2002:a92:1f12:0:0:0:0:0 with SMTP id i18csp1844407ile; Thu, 6 Feb 2020 09:44:46 -0800 (PST) X-Google-Smtp-Source: APXvYqyYMikw5OiyaAiOfYf5abU0y8l33Q08DowSZqqvY2qJRWnKI1ChP7ZgBO/SQPz/9/kFYE2u X-Received: by 2002:a0c:f685:: with SMTP id p5mr3405491qvn.44.1581011086636; Thu, 06 Feb 2020 09:44:46 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1581011086; cv=none; d=google.com; s=arc-20160816; b=TyFi6f2cqXVSb7BQSdWWOFHo2eeBJu5dpzDwxnPFFna6//xc0eA/rk1YKWJg3Cjkck 95OrCf64d9j2uYSXSCFjVVG/ITCv4hINyu/m/zxMf8xRTn0YCzRyoplkRm85sO6NM4Oz Xp5Pe0+3R2KGc0+jO/j6RlOYKkSwM9GE0tPuekx9jNeVMV7bXKsPLmxddWTgzNC87yPl jQgQdbGhmvpiHmkNybamYSwAJdKKCziNvExCzWCkqFY57Ovyj9j71MqzIvTadZ8I6dJd 5hcVq/mY2QnFH2Rav+ttpo1sDNyy1UEAuqmO0pawrPc5UJucvsJUzri944yRFiz4BtX1 Trig== 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=r46aBihEOGQbzY2WpFB3AupNkAhrK/38I7UbJd+jXYs=; b=YUk2B1KL0EDV59CAjLGGE5FIEH60d5vNzG2Y6OKnGsgYwglpnkG++lc1gQZXFyNRd8 d2wzH2UAfahH0RWopJoGxdnNkx8UybyfSBHJ6Vr1m8ckJlxnnIE0OT1A8YdCSzItPmB1 4Fq+MHUXkCpLXN0khHYKl1qydrfKpI+mL/rQrtNS3ElEBmE7gf1h1V0GUZaBOkbRH+Ka /PBCxskkmNj9RTgSjoBm9SnAv5PQhzWkqrLbrvyQwqQaj6wGtacfO3gTjtXxWuKQYpN+ a8WqAznXevDPMYzfXlDXEo4kfKtQJlg1EQ+Az+nYPwf3fQI3gAITiheqx3cz/TZvSu9F y1Ng== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=hj+8A4MG; 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 g6si1899737qkl.203.2020.02.06.09.44.46 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Thu, 06 Feb 2020 09:44:46 -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=hj+8A4MG; 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]:43656 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1izlCo-0004Si-53 for patch@linaro.org; Thu, 06 Feb 2020 12:44:46 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:43658) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1izl09-0006uu-AE for qemu-devel@nongnu.org; Thu, 06 Feb 2020 12:31:42 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1izl08-00071R-5Q for qemu-devel@nongnu.org; Thu, 06 Feb 2020 12:31:41 -0500 Received: from mail-wr1-x42b.google.com ([2a00:1450:4864:20::42b]:42904) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1izl07-0006xa-V3 for qemu-devel@nongnu.org; Thu, 06 Feb 2020 12:31:40 -0500 Received: by mail-wr1-x42b.google.com with SMTP id k11so8181586wrd.9 for ; Thu, 06 Feb 2020 09:31:39 -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=r46aBihEOGQbzY2WpFB3AupNkAhrK/38I7UbJd+jXYs=; b=hj+8A4MGp5X+dxRQ1rF1O0gSrKg3TP0Jn6m+dX9hjIgl9pmrFNY9FA+vqDwmNG77pc JfbSerHKFnq9kWU2fypJ60cipFsCpMssa44FDAGclNeb8Uxn+Qbscy2/1+M74rmXWrig WU8UC6PcJo/2QIN5KMWIO45Ak21Lzgy4l/5pb+GxWIHVmcC9Srg9EbhK61zMb9x4bmpR kz+eDrixeMP5SuURsHPp5q6zWRqtfEFS4fIZq6FkQ8SNj9lUQaVo1PgHZvgKjgm6zXFE 8QIKihCxs4pQV72PhC/C8yfjZtq+9r5SESDhfsZGTwmrmHoNEh7vMtiyRXMP1/9PSpiQ jQLw== 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=r46aBihEOGQbzY2WpFB3AupNkAhrK/38I7UbJd+jXYs=; b=Ej7sM9/2M+YnS2MQRgCTEDT/FgOVHIDiXBEjd4l0VRDnjkzipM6kurdM20wJkUAPUp 1PTvdqMETzJcfFghsW30k48STIOpPKsCZXjViDbZtz3/Zu/ogLiOyR73PaIiu8krlhbM 0tuRSNMYPp/EtgtOSfB2A7xQLAboMeR/W9Mz4zJhAbNXZgyMq09mi2Cmxg+DcZro+a2m CgiiWSZvPXcBi4hv4yCwIpcuoUN7WX/6vx+OYgSYG/sjM1muBaGoIB1w9gzfsuiY3iGe QFWpyBnKdKPB8qiV55+PkePIsKvFo+JKdP7005Ern3+F+cQe5qpglp07UYlti6ve0Mcs M8mg== X-Gm-Message-State: APjAAAWKkkDDMHEJucoOKWYUbFwd9BArU8nENtJhkB37Ml/dmDKStUrN T1n1AR9mcAcPUGceEAFGPxYkIF6nkFk= X-Received: by 2002:adf:fa50:: with SMTP id y16mr5226789wrr.204.1581010298564; Thu, 06 Feb 2020 09:31:38 -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.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 06 Feb 2020 09:31:38 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH 26/29] qapi: Use rST markup for literal blocks Date: Thu, 6 Feb 2020 17:30:37 +0000 Message-Id: <20200206173040.17337-27-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::42b 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 092cd8f13d9..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.