From patchwork Thu Feb 6 17:30:23 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 183109 Delivered-To: patch@linaro.org Received: by 2002:a92:1f12:0:0:0:0:0 with SMTP id i18csp1836649ile; Thu, 6 Feb 2020 09:37:10 -0800 (PST) X-Google-Smtp-Source: APXvYqzKOIK4xD6f8DMCLQJDUMnWc9/iDK6wE9SfOYR67y6DZvhXNkwpXi01kiyOvahbrHbGNCxD X-Received: by 2002:aed:2643:: with SMTP id z61mr3728084qtc.49.1581010630719; Thu, 06 Feb 2020 09:37:10 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1581010630; cv=none; d=google.com; s=arc-20160816; b=j2p/s+MkbtcLlvpRZfkSBHCUrOrIzyqwq40eimDRkRdJ5E9OlVsD2Pa6VqnDIrvgZp MMF07Q/uctn4XEPg5GzsBw8EQ0/G1JjKPSl0DCpDwoUoJ0pfa2ZWyOqy+kOlwwrQEstB oRI2e1SgcRFwZ8e6MK1eOzMORSI8QZ5BfKlQ/B/iZvxv0e0DxcvG/RgIjpEWZWxNqGHh tW5oZpLcxp0vK0Icm6GzLTJkbvcS18eNzAISmXHaRQCufh6pwlqUKU+pNb/jAnRtLv8M MSuNwWtz2elCANR+u6Jcp9DUlQVWgkp4MrR0kALVY+ZPyciBt47bFN7juRvxVaYc3pqV 0BuA== 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=ny3WK8pMdlgBlAoYUdqL7k5E1SZb/jHOFqlIQGucr5M=; b=Liu/iNxCwMOxTYbA1eavk9OtQjeeOMRWQ1z3nCM3H165JBPNU+XM3uK0rTtXMwQ2d+ gyc+0XDr+PcvQxbJwqo6eo3Iz2PlgwhQ66K6DOcFIo5Eb7JSVpHytERwq9cg9DxQQXwC tSeE0eFXUMAZhDhCr4esuwu4pwPy86NQ7wwYI1KOc5HWd6Ttp+YcsYuAkeOTzPO1Ezda NlTUNjRQf3E2JLwEbs5GpLfZJUsjC0UzRIntrHHFlGf8F6KsNhW84GoszNX+enywathu /XcY74ivFAk7wWEqW0y5tEvWv7OOXiDZlcASeWgx/hKo+0H9tRFb2TiHWvyrxLXQEcdt Lepg== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=Y6xUIs5h; 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 s16si1813890qkg.237.2020.02.06.09.37.10 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Thu, 06 Feb 2020 09:37:10 -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=Y6xUIs5h; 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]:43424 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1izl5S-0006ER-7Q for patch@linaro.org; Thu, 06 Feb 2020 12:37:10 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:43458) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1izkzq-0006hH-Rz for qemu-devel@nongnu.org; Thu, 06 Feb 2020 12:31:24 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1izkzp-0005ug-KB for qemu-devel@nongnu.org; Thu, 06 Feb 2020 12:31:22 -0500 Received: from mail-wr1-x429.google.com ([2a00:1450:4864:20::429]:37839) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1izkzp-0005mn-Cd for qemu-devel@nongnu.org; Thu, 06 Feb 2020 12:31:21 -0500 Received: by mail-wr1-x429.google.com with SMTP id w15so8200394wru.4 for ; Thu, 06 Feb 2020 09:31:21 -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=ny3WK8pMdlgBlAoYUdqL7k5E1SZb/jHOFqlIQGucr5M=; b=Y6xUIs5hWVoM0LMDBumGmw7SFmqozh4Bbo6rVPQmqjYeJWOpG75nQww3he5bpG3yyn IDRsEz7dn6SVqidsaUU2x2yhlc3tleCepXRiGf4BpUp6/QJwTD5q/U3/4GTFWI4mv+N1 x6a7Qe6//NcHM/r2CxO0xD8MfUuV4UOOUUjNWQVUHl49F3ilWjD6JdAtZkNbjT0L5fpL dfDUCgBcUFaAJZQdaMdPMd3ZMoGKMGuIFeUdG7ULHDtf1xCi4BB4jaQwLpdkQVU8Ocze iqxEDrVD97QNelejlK/WeBgFs8VLDIJeDfsrVwIxWp3PXOq1RcrVbXDWooMSsInXit8L 77kA== 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=ny3WK8pMdlgBlAoYUdqL7k5E1SZb/jHOFqlIQGucr5M=; b=oU/mAFZCF77Od/kx5cObIrLQh1qfSoPBxSQsiEoXLZn5N2mqj9ih71liLK1MyrJvs/ Ssnedngk8HdiuHNvhvsheyME/ocnlvySlTCGoqYTPgv4zgdDNoYrw1oOFvk8dj4mrK/z 5wt3w7WmZBAO5bZKu41aS4hMVp7ZG/UYd7brSBoLaN2Nji9NDQVNnRkL0dPFSm7kWOAz Dd2XiPGkiUFwVpKJScHONtNSGowML0U5GmDrtlAAM6vbgQ5F6HJKtwJiWhlsYGxVEN+S 9zghjO5fvQfZ4NIEXoTcyQ5BNpiHMBYPHa04+AMNzERzVQepKKRy7RMBQxM1pr/xS7h/ W09w== X-Gm-Message-State: APjAAAWegsZOH3uEu2+u4ibTxxGWbOpflhKLuRKp4+WZg18swPjUfWrF 9/oumVa1u6Y2QZQOs+z6gaSeYpsApaM= X-Received: by 2002:adf:f0ca:: with SMTP id x10mr5036186wro.423.1581010277659; Thu, 06 Feb 2020 09:31:17 -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.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 06 Feb 2020 09:31:16 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH 12/29] qapi: Explicitly put "foo: dropped in n.n" notes into Notes section Date: Thu, 6 Feb 2020 17:30:23 +0000 Message-Id: <20200206173040.17337-13-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::429 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 handful of QAPI doc comments include lines like "ppcemb: dropped in 3.1". The doc comment parser will just put these into whatever the preceding section was; sometimes that's "Notes", and sometimes it's some random other section, as with "NetClientDriver" where the "'dump': dropped in 2.12" line ends up in the "Since:" section. Put all of these explicitly into Notes: sections (either preexisting or new), with the right indentation, and standardising on quoting of the symbol with ''. In the case of QKeyCode, the generated docs were actively misformatted: ac_bookmarks since 2.10 altgr, altgr_r: dropped in 2.10 Signed-off-by: Peter Maydell --- qapi/machine.json | 2 +- qapi/net.json | 6 +++--- qapi/ui.json | 3 ++- 3 files changed, 6 insertions(+), 5 deletions(-) -- 2.20.1 diff --git a/qapi/machine.json b/qapi/machine.json index 704b2b0fe31..51ffa96be98 100644 --- a/qapi/machine.json +++ b/qapi/machine.json @@ -20,7 +20,7 @@ # prefix to produce the corresponding QEMU executable name. This # is true even for "qemu-system-x86_64". # -# ppcemb: dropped in 3.1 +# 'ppcemb': dropped in 3.1 # # Since: 3.0 ## diff --git a/qapi/net.json b/qapi/net.json index 109eff71cd4..8fbcbc611b9 100644 --- a/qapi/net.json +++ b/qapi/net.json @@ -447,7 +447,7 @@ # # Since: 2.7 # -# 'dump': dropped in 2.12 +# Notes: 'dump': dropped in 2.12 ## { 'enum': 'NetClientDriver', 'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde', @@ -464,7 +464,7 @@ # # Since: 1.2 # -# 'l2tpv3' - since 2.1 +# Notes: 'l2tpv3' - since 2.1 ## { 'union': 'Netdev', 'base': { 'id': 'str', 'type': 'NetClientDriver' }, @@ -494,7 +494,7 @@ # # Since: 1.2 # -# 'vlan': dropped in 3.0 +# Notes: 'vlan': dropped in 3.0 ## { 'struct': 'NetLegacy', 'data': { diff --git a/qapi/ui.json b/qapi/ui.json index 94a07318f55..6da52b81143 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -776,7 +776,6 @@ # @ac_forward: since 2.10 # @ac_refresh: since 2.10 # @ac_bookmarks: since 2.10 -# altgr, altgr_r: dropped in 2.10 # # @muhenkan: since 2.12 # @katakanahiragana: since 2.12 @@ -790,6 +789,8 @@ # # Since: 1.3.0 # +# Notes: - 'altgr': dropped in 2.10 +# - 'altgr_r': dropped in 2.10 ## { 'enum': 'QKeyCode', 'data': [ 'unmapped',