From nobody Mon May 20 19:42:19 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=1683728246; cv=none; d=zohomail.com; s=zohoarc; b=YxROzLtI180mFm9StAlM2eNx/D9Q13Ph/oS4TLvHvx0i4prXPmaiAx9gE/8qN3YNT9bWEYEn4EIOj3t3cTjXY4TO8gH7iY9b96iZkB6jIMfPwbwtjUpyC9jxZePLZgvwNOF1YprIG9x0LWBISfkcFGVfqiB6zkDT33pR24ZKt1k= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1683728246; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=sMrQ3HlHGsOR2pmk7V/A7t8ZTVswJzn54r6gF2xv/7E=; b=ZoKR+By4fuK3kg/lxbcalgYDOfbhsR6QBrc//e59x+6V+HGjLRDg5H2y6RHrmdUykLiANZiEttAUrKZhl7fsE4A6h9LkFpbuF9T1pnwdTEIIHefMRdOSMu6X/ZidnEVy+vTHGQFYgMeSM43WgmAQwvi0FQ/Dtjd/SiycZU+HYAQ= 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 1683728246662487.4463951830221; Wed, 10 May 2023 07:17:26 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pwkcZ-00029x-L9; Wed, 10 May 2023 10:16:47 -0400 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 1pwkcX-00029o-Je for qemu-devel@nongnu.org; Wed, 10 May 2023 10:16:45 -0400 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 1pwkcV-000891-Va for qemu-devel@nongnu.org; Wed, 10 May 2023 10:16:45 -0400 Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-31-XylugQbwOXu1H5CJRzAA6w-1; Wed, 10 May 2023 10:16:39 -0400 Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 38E7E28135A2; Wed, 10 May 2023 14:16:39 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.121]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 0D997492C13; Wed, 10 May 2023 14:16:39 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id E0C1821E6924; Wed, 10 May 2023 16:16:37 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1683728202; 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=sMrQ3HlHGsOR2pmk7V/A7t8ZTVswJzn54r6gF2xv/7E=; b=C7Rm+ba0inAMOGT7DcsH/BmJxasJvRAnG5T1JiEqDpNCa9OGl3dSh/hvKncB9w02ElJmF8 LXxSPBtNOb0ZIhJYrY2VPrhHZVU4bdffBH5fFjUW+Rv0mTr/bSDWGHGA03IzwWSX6bBnGb ZACpvP4acOn9SAbncokTbiItYTXgbUw= X-MC-Unique: XylugQbwOXu1H5CJRzAA6w-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: michael.roth@amd.com, jsnow@redhat.com, quintela@redhat.com Subject: [PATCH] qapi: Improve error message for description following section Date: Wed, 10 May 2023 16:16:37 +0200 Message-Id: <20230510141637.3685080-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.1 on 10.11.54.10 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, 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: 1683728247455100001 Content-Type: text/plain; charset="utf-8" The error message is bad when the section is untagged. For instance, test case doc-interleaved-section produces "'@foobar:' can't follow 'Note' section", which is okay, but if we drop the "Note:" tag, we get "'@foobar:' can't follow 'None' section, which is bad. Change the error message to "description of '@foobar:' follows a section". Signed-off-by: Markus Armbruster Reviewed-by: Juan Quintela --- scripts/qapi/parser.py | 4 ++-- tests/qapi-schema/doc-interleaved-section.err | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index 878f90b458..3de467493f 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -700,8 +700,8 @@ def _append_various_line(self, line: str) -> None: =20 if name.startswith('@') and name.endswith(':'): raise QAPIParseError(self._parser, - "'%s' can't follow '%s' section" - % (name, self.sections[0].name)) + "description of '%s' follows a section" + % name) if self._is_section_tag(name): # If line is "Section: first line of description", find # the index of 'f', which is the indent we expect for any diff --git a/tests/qapi-schema/doc-interleaved-section.err b/tests/qapi-sch= ema/doc-interleaved-section.err index 715d58cd31..e5d1ef54c1 100644 --- a/tests/qapi-schema/doc-interleaved-section.err +++ b/tests/qapi-schema/doc-interleaved-section.err @@ -1 +1 @@ -doc-interleaved-section.json:15:1: '@foobar:' can't follow 'Note' section +doc-interleaved-section.json:15:1: description of '@foobar:' follows a sec= tion --=20 2.39.2