From nobody Sat May 18 18:27:40 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1676294458; cv=none; d=zohomail.com; s=zohoarc; b=Spwan26A/nlIxlrAGdKV8lPwTlIsDRSpcKofQOvLWT8AjidlWZLt0F2ncl2mM8XZWSRpPpzA5zF7lVyKh3l/bWZHcBSU78hI+VilYmCL/sbIgmFj+Zda0zZRSEhl4727tYanHxppD2l5XtD1AcrN+jHt5b2fQl/ToT8cDGWTTQQ= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1676294458; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=m07ug/T/MnxRSeH6N3RgSpnfEsy/mmzHpZVZUaoWre4=; b=WwOhjXH1yNfGbi3I3Um3JJfgDNsgKzbxz7T3dSvlg+Q7VXAJuRhQGILIgC12/dRnoNCUaiBhiYCcxp5mvxWPvxqsc5yMK1RL5DbEHTCBc46j0xCnxMrSJLrEKhJzS8rqDGzhFr8u7aE7PrtW93ATJahA80pIJjP3IXWSKX3Kw4M= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1676294458841142.0726627233563; Mon, 13 Feb 2023 05:20:58 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pRYkm-0002ti-RD; Mon, 13 Feb 2023 08:20:20 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pRYkj-0002qk-Al for qemu-devel@nongnu.org; Mon, 13 Feb 2023 08:20:17 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pRYkf-0005dL-RV for qemu-devel@nongnu.org; Mon, 13 Feb 2023 08:20:15 -0500 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-41-PTQTnJuIO4GIvp2ujRXMBQ-1; Mon, 13 Feb 2023 08:20:11 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id E3F44858F0E; Mon, 13 Feb 2023 13:20:10 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.124]) by smtp.corp.redhat.com (Postfix) with ESMTPS id C18A340398A0; Mon, 13 Feb 2023 13:20:10 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 6527F21E6A20; Mon, 13 Feb 2023 14:20:09 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1676294412; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=m07ug/T/MnxRSeH6N3RgSpnfEsy/mmzHpZVZUaoWre4=; b=NhSfd4FYfD1afZCac40SNtfO6Bm7r5KsI3D8bNIuEYMVr6BhuD7xeP52MDRMMWqFt3Uaxh 2VJUoG60SLurn7Rg7Uvj5bCbbWJJu9V+h3kyP+xNYz1Gwobi2lrm3GAB9NXfsiHGg+HyGy WejTe5ndci9x5Kh7LqbdfcKP99mvUs8= X-MC-Unique: PTQTnJuIO4GIvp2ujRXMBQ-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: michael.roth@amd.com, jsnow@redhat.com, eblake@redhat.com, marcandre.lureau@redhat.com Subject: [PATCH 1/2] docs/devel/qapi-code-gen: Belatedly update features documentation Date: Mon, 13 Feb 2023 14:20:08 +0100 Message-Id: <20230213132009.918801-2-armbru@redhat.com> In-Reply-To: <20230213132009.918801-1-armbru@redhat.com> References: <20230213132009.918801-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.1 on 10.11.54.2 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1676294460454100003 Content-Type: text/plain; charset="utf-8" Commit 013b4efc9be "qapi: Add feature flags to remaining definitions" (v5.0.0), commit 84ab0086879 "qapi: Add feature flags to struct members" (v5.0.0), and commit b6c18755e41 "qapi: Add feature flags to enum members" (v6.2.0) neglected to update section "Features". Make up for that. Signed-off-by: Markus Armbruster Reviewed-by: Eric Blake Reviewed-by: John Snow --- docs/devel/qapi-code-gen.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst index 5edc49aa74..566640edf8 100644 --- a/docs/devel/qapi-code-gen.rst +++ b/docs/devel/qapi-code-gen.rst @@ -685,9 +685,10 @@ change in the QMP syntax (usually by allowing values o= r operations that previously resulted in an error). QMP clients may still need to know whether the extension is available. =20 -For this purpose, a list of features can be specified for a command or -struct type. Each list member can either be ``{ 'name': STRING, '*if': -COND }``, or STRING, which is shorthand for ``{ 'name': STRING }``. +For this purpose, a list of features can be specified for definitions, +enumeration values, and struct members. Each feature list member can +either be ``{ 'name': STRING, '*if': COND }``, or STRING, which is +shorthand for ``{ 'name': STRING }``. =20 The optional 'if' member specifies a conditional. See `Configuring the schema`_ below for more on this. --=20 2.39.0 From nobody Sat May 18 18:27:40 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1676296142; cv=none; d=zohomail.com; s=zohoarc; b=atp7qeDtfcynkagoA9LiSmXlPoAdEUzmvmssYQAlrKtCzEL7OwXF/6I64nCRQmSFU7rkMm2iTgDaQ8eQ4AH/gjMH1WkFuHCWmMpXD0i27uhc5/LiuOC8G3RiojGqHfM6mzyKMAdtN5kIttG40vwUsQwsxF2QQaR8uIktmPPUnIA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1676296142; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=N7oqbMUKqtpz4aFfVXDJnF5J5+6Za3gx/PBBqzaeKQs=; b=KeMvuu5peLQ3X7zNxcCQ8KWW3DhTpVcWtnl0KeMAdyz2pQzs1w5Y13aWiCbPORvEeCaSG0OUJtGeTnAeJKKtQDh9yw9sjtHO25G9fRZTuaFRXOggoM80r7rZgb8o0K0htXfwcgd+/jqkeMeixKz6zk7ETnnbEtsPgxK/uDA3iNU= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1676296142216750.3496579903276; Mon, 13 Feb 2023 05:49:02 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pRYkn-0002ua-Ev; Mon, 13 Feb 2023 08:20:21 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pRYkk-0002rE-8h for qemu-devel@nongnu.org; Mon, 13 Feb 2023 08:20:18 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pRYkh-0005dW-HC for qemu-devel@nongnu.org; Mon, 13 Feb 2023 08:20:17 -0500 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-259-7ld9yOGaMa6tntDShF2S0A-1; Mon, 13 Feb 2023 08:20:11 -0500 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id E2AEA101A521; Mon, 13 Feb 2023 13:20:10 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.124]) by smtp.corp.redhat.com (Postfix) with ESMTPS id C164C40B40C9; Mon, 13 Feb 2023 13:20:10 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 67EF821E6A21; Mon, 13 Feb 2023 14:20:09 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1676294413; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=N7oqbMUKqtpz4aFfVXDJnF5J5+6Za3gx/PBBqzaeKQs=; b=NwMP3xEVEfegPhPN3xJyvtbqQuWEBt29YeFjhgxkqJVXaoZwcStg5ZbWa1GlwD7JC6wB7R 9hcVp4f9ObTSPhZsCVmL2HV6tIlGfVfFUfXpBCGNT6e0BnMOF3rLCi2vCc+bbiSBx80Ndl x/netl/JUjmmjAupWfKlVJD7PnC2jtA= X-MC-Unique: 7ld9yOGaMa6tntDShF2S0A-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: michael.roth@amd.com, jsnow@redhat.com, eblake@redhat.com, marcandre.lureau@redhat.com Subject: [PATCH 2/2] docs/devel/qapi-code-gen: Fix a missing 'may', clarify SchemaInfo Date: Mon, 13 Feb 2023 14:20:09 +0100 Message-Id: <20230213132009.918801-3-armbru@redhat.com> In-Reply-To: <20230213132009.918801-1-armbru@redhat.com> References: <20230213132009.918801-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.1 on 10.11.54.1 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1676296142603100001 Content-Type: text/plain; charset="utf-8" Documentation of enumeration value conditions lacks a 'may'. Fix that. Clarify SchemaInfo documentation for struct and union types. Signed-off-by: Markus Armbruster Reviewed-by: Eric Blake Reviewed-by: John Snow --- docs/devel/qapi-code-gen.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst index 566640edf8..23e7f2fb1c 100644 --- a/docs/devel/qapi-code-gen.rst +++ b/docs/devel/qapi-code-gen.rst @@ -818,8 +818,8 @@ member 'bar' :: =20 A union's discriminator may not be conditional. =20 -Likewise, individual enumeration values be conditional. This requires -the longhand form of ENUM-VALUE_. +Likewise, individual enumeration values may be conditional. This +requires the longhand form of ENUM-VALUE_. =20 Example: an enum type with unconditional value 'foo' and conditional value 'bar' :: @@ -1158,9 +1158,8 @@ Example: the SchemaInfo for EVENT_C from section Even= ts_ :: Type "q_obj-EVENT_C-arg" is an implicitly defined object type with the two members from the event's definition. =20 -The SchemaInfo for struct and union types has meta-type "object". - -The SchemaInfo for a struct type has variant member "members". +The SchemaInfo for struct and union types has meta-type "object" and +variant member "members". =20 The SchemaInfo for a union type additionally has variant members "tag" and "variants". --=20 2.39.0