From nobody Tue Nov 26 22:11:04 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=1703170715; cv=none; d=zohomail.com; s=zohoarc; b=ekYihvPIDGnEFIL2mCHmias1924QQInuALkOkbG9tYttTeNpFR70C3393n8lHtLqmXqTBAL/ldAjsSEj5qCbP7W7RpLF6Na2CVYdSkHksMbCTqMJ8SDEySGTxXWYqyIBt1kNOYH2hj2Ok8G3jDDSmWb98bdStJY5eSu0SH8cg/o= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1703170715; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=PnGM5Wb7rrBFn6sw2kitY24V1MnlyeP8A23eyqpjcag=; b=gK8j9y052QJdZgxk69VnGlFc1fc2tGyxd/lYhBvw+9rt7kM6yv5WjtlJnACkEAidhfxYkHUaKPSZN+CbwEzi2TlmXruOYgc6jjx2LTVxdYs9QInLQXqSQRfHSA9QWWIfXHrebc2H6Edi1lIQPrlfAR7ejmViu3OsqLsY1Bu5Lnk= 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 1703170715777674.6208161379037; Thu, 21 Dec 2023 06:58:35 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rGKUZ-0005bg-Gm; Thu, 21 Dec 2023 09:57:43 -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 1rGKUX-0005bT-V2 for qemu-devel@nongnu.org; Thu, 21 Dec 2023 09:57:41 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rGKUS-0000MQ-Oj for qemu-devel@nongnu.org; Thu, 21 Dec 2023 09:57:41 -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.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-382-tvhxFamqM9KI9d4ZqdhzXw-1; Thu, 21 Dec 2023 09:57:28 -0500 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 91C2B8B2828; Thu, 21 Dec 2023 14:57:28 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.129]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 6872A51D5; Thu, 21 Dec 2023 14:57:28 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 4E02121E6920; Thu, 21 Dec 2023 15:57:27 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1703170652; 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; bh=PnGM5Wb7rrBFn6sw2kitY24V1MnlyeP8A23eyqpjcag=; b=eNqMVs3+wux5hWgb1wERvLvCL23THQWsejmbt5taG0AfdaYY6PKOf/o03X/QpxyrtJPKwB Lswoun1BlYJJ+4xqoOjY7/mF27apZaaCmPY6wQzXg2Ttday6CwmPV5pyhzQrH697RosKh9 qRq/fJFdTY4PAw8n0mwT2wlIdNLb6GA= X-MC-Unique: tvhxFamqM9KI9d4ZqdhzXw-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: michael.roth@amd.com, eblake@redhat.com Subject: [PATCH] docs/devel/qapi-code-gen: Don't reserve types ending with 'Kind' Date: Thu, 21 Dec 2023 15:57:27 +0100 Message-ID: <20231221145727.835905-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.5 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.133.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.061, 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_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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: 1703170716611100001 Content-Type: text/plain; charset="utf-8" We reserved type names ending with 'Kind' because a simple union 'SomeSimpleUnion' generated both a struct type SomeSimpleUnion and an enum type SomeSimpleUnionKind. Gone since commit 4e99f4b12c0 (qapi: Drop simple unions). The commit neglected to update the documentation not to reserve type names ending with 'Kind'. Do that now. Signed-off-by: Markus Armbruster --- docs/devel/qapi-code-gen.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst index 7f78183cd4..972b21a5aa 100644 --- a/docs/devel/qapi-code-gen.rst +++ b/docs/devel/qapi-code-gen.rst @@ -737,9 +737,8 @@ Types, commands, and events share a common namespace. = Therefore, generally speaking, type definitions should always use CamelCase for user-defined type names, while built-in types are lowercase. =20 -Type names ending with ``Kind`` or ``List`` are reserved for the -generator, which uses them for implicit union enums and array types, -respectively. +Type names ending with ``List`` are reserved for the generator, which +uses them for array types. =20 Command names, member names within a type, and feature names should be all lower case with words separated by a hyphen. However, some --=20 2.43.0