From nobody Fri Nov 1 07:31:24 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=1708095819; cv=none; d=zohomail.com; s=zohoarc; b=bIVDfrlWDl3m05IJW1E92tA8Xr5/xultV9yOKzO+yoXCWvBwSNNX+9VkrwT5nRJTzct9Oi5DXWBaSpD/owa/zUTfCq28DXYA93/jl8fr95rEzxC5h9B2R63OSRlIKtITH1PjQ+Sc07Wxz7kB5KFax+uCxdl5O/OjkWdE8ufsQMc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1708095819; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=quNPGzAfYk4xijW3ChKUFh1qR6poXO1qlh5/lMiUjvM=; b=fkHOHXQkc00Bm+9oxwpeDWVLwva0+EXvbjmluxQUcHoRkRMWJyCoDGAQjmK8Siwto4n0yrjmVUTWNn2hSAeuKQm6ciAs28U48T70hgDUtdqFU+iI8F/vb7p5f0+0hkh1h4y+QfjZmbURyaVtcKBzf0CqewPNIYxYi7UgOghrs9A= 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 1708095819685545.5029479499228; Fri, 16 Feb 2024 07:03:39 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1razg6-0005y2-Vm; Fri, 16 Feb 2024 09:59:03 -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 1razg1-0005tO-9l for qemu-devel@nongnu.org; Fri, 16 Feb 2024 09:58:57 -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 1razfx-00083D-Tw for qemu-devel@nongnu.org; Fri, 16 Feb 2024 09:58:57 -0500 Received: from mimecast-mx02.redhat.com (mx-ext.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-353-kHQYADYhO6qhNVCwBBPQaw-1; Fri, 16 Feb 2024 09:58:49 -0500 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) (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 A41381C0433B; Fri, 16 Feb 2024 14:58:49 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.55]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 6485D2166B4F; Fri, 16 Feb 2024 14:58:49 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 3C36D21E5A5B; Fri, 16 Feb 2024 15:58:41 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1708095533; 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=quNPGzAfYk4xijW3ChKUFh1qR6poXO1qlh5/lMiUjvM=; b=TM7u8YZlMuJjafmUz4Ud2JmHsseZKVl2+S+qnB4244BWKaYzsmgAycLFCoI/lGpZIzXjfJ EehBdkWWJK2r509pzz5Cx92fk7lvKqTiKcamS2cKNdh948taBZC3SK/qrB1pG+m2E5VYgq qB6Dr2b0/TvFZLk/Iw06Ew2FFJUtvCQ= X-MC-Unique: kHQYADYhO6qhNVCwBBPQaw-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: michael.roth@amd.com, jsnow@redhat.com, eblake@redhat.com, peter.maydell@linaro.org Subject: [PATCH 15/16] qapi: Reject multiple and empty feature descriptions Date: Fri, 16 Feb 2024 15:58:39 +0100 Message-ID: <20240216145841.2099240-16-armbru@redhat.com> In-Reply-To: <20240216145841.2099240-1-armbru@redhat.com> References: <20240216145841.2099240-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.6 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: -24 X-Spam_score: -2.5 X-Spam_bar: -- X-Spam_report: (-2.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.364, 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, 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: 1708095821443100015 Content-Type: text/plain; charset="utf-8" The parser recognizes only the first "Features:" line. Any subsequent ones are treated as ordinary text, as visible in test case doc-duplicate-features. Recognize "Features:" lines anywhere. A second one is an error. A 'Features:' line without any features is useless, but not an error. Make it an error. This makes detecting a second "Features:" line easier. qapi/run-state.json actually has an instance of this since commit fe17522d854 (qapi: Remove deprecated 'singlestep' member of StatusInfo). Clean it up. Signed-off-by: Markus Armbruster Reviewed-by: Daniel P. Berrang=C3=A9 --- qapi/run-state.json | 2 -- scripts/qapi/parser.py | 8 ++++++- tests/qapi-schema/doc-duplicate-features.err | 1 + tests/qapi-schema/doc-duplicate-features.out | 22 -------------------- tests/qapi-schema/doc-empty-features.err | 1 + tests/qapi-schema/doc-empty-features.out | 17 --------------- 6 files changed, 9 insertions(+), 42 deletions(-) diff --git a/qapi/run-state.json b/qapi/run-state.json index d19d23a0fd..dd0770b379 100644 --- a/qapi/run-state.json +++ b/qapi/run-state.json @@ -108,8 +108,6 @@ # # @status: the virtual machine @RunState # -# Features: -# # Since: 0.14 # ## diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index 73ff150430..3d8c62b412 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -507,7 +507,10 @@ def get_doc(self) -> 'QAPIDoc': if line is None: break # Non-blank line, first of a section - if line =3D=3D 'Features:' and not doc.features: + if line =3D=3D 'Features:': + if doc.features: + raise QAPIParseError( + self, "duplicated 'Features:' line") self.accept(False) line =3D self.get_doc_line() while line =3D=3D '': @@ -520,6 +523,9 @@ def get_doc(self) -> 'QAPIDoc': if text: doc.append_line(text) line =3D self.get_doc_indented(doc) + if not doc.features: + raise QAPIParseError( + self, 'feature descriptions expected') no_more_args =3D True elif match :=3D self._match_at_name_colon(line): # description diff --git a/tests/qapi-schema/doc-duplicate-features.err b/tests/qapi-sche= ma/doc-duplicate-features.err index e69de29bb2..cadb2957a6 100644 --- a/tests/qapi-schema/doc-duplicate-features.err +++ b/tests/qapi-schema/doc-duplicate-features.err @@ -0,0 +1 @@ +doc-duplicate-features.json:9:1: duplicated 'Features:' line diff --git a/tests/qapi-schema/doc-duplicate-features.out b/tests/qapi-sche= ma/doc-duplicate-features.out index 43bfe1034b..e69de29bb2 100644 --- a/tests/qapi-schema/doc-duplicate-features.out +++ b/tests/qapi-schema/doc-duplicate-features.out @@ -1,22 +0,0 @@ -module ./builtin -object q_empty -enum QType - prefix QTYPE - member none - member qnull - member qnum - member qstring - member qdict - member qlist - member qbool -module doc-duplicate-features.json -command foo None -> None - gen=3DTrue success_response=3DTrue boxed=3DFalse oob=3DFalse preconfig= =3DFalse - feature feat -doc symbol=3Dfoo - body=3D - - feature=3Dfeat -mumble - section=3DNone -Features: diff --git a/tests/qapi-schema/doc-empty-features.err b/tests/qapi-schema/d= oc-empty-features.err index e69de29bb2..2709a18d8f 100644 --- a/tests/qapi-schema/doc-empty-features.err +++ b/tests/qapi-schema/doc-empty-features.err @@ -0,0 +1 @@ +doc-empty-features.json:8:1: feature descriptions expected diff --git a/tests/qapi-schema/doc-empty-features.out b/tests/qapi-schema/d= oc-empty-features.out index 473f59552d..e69de29bb2 100644 --- a/tests/qapi-schema/doc-empty-features.out +++ b/tests/qapi-schema/doc-empty-features.out @@ -1,17 +0,0 @@ -module ./builtin -object q_empty -enum QType - prefix QTYPE - member none - member qnull - member qnum - member qstring - member qdict - member qlist - member qbool -module doc-empty-features.json -command foo None -> None - gen=3DTrue success_response=3DTrue boxed=3DFalse oob=3DFalse preconfig= =3DFalse -doc symbol=3Dfoo - body=3D -not a description --=20 2.43.0