From nobody Thu Nov 6 16:07:59 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zoho.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1489387714514871.3897929286899; Sun, 12 Mar 2017 23:48:34 -0700 (PDT) Received: from localhost ([::1]:50500 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cnJmT-0006Yo-As for importer@patchew.org; Mon, 13 Mar 2017 02:48:33 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:52429) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cnJJr-0007bN-4N for qemu-devel@nongnu.org; Mon, 13 Mar 2017 02:19:05 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cnJJm-0003eT-LA for qemu-devel@nongnu.org; Mon, 13 Mar 2017 02:18:59 -0400 Received: from mx1.redhat.com ([209.132.183.28]:50816) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1cnJJm-0003bl-AH for qemu-devel@nongnu.org; Mon, 13 Mar 2017 02:18:54 -0400 Received: from int-mx14.intmail.prod.int.phx2.redhat.com (int-mx14.intmail.prod.int.phx2.redhat.com [10.5.11.27]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 502CDC04B93B; Mon, 13 Mar 2017 06:18:54 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-116-55.ams2.redhat.com [10.36.116.55]) by int-mx14.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id v2D6Iqif003270 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=NO); Mon, 13 Mar 2017 02:18:54 -0400 Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 7FC4511384B7; Mon, 13 Mar 2017 07:18:47 +0100 (CET) From: Markus Armbruster To: qemu-devel@nongnu.org Date: Mon, 13 Mar 2017 07:18:33 +0100 Message-Id: <1489385927-6735-34-git-send-email-armbru@redhat.com> In-Reply-To: <1489385927-6735-1-git-send-email-armbru@redhat.com> References: <1489385927-6735-1-git-send-email-armbru@redhat.com> X-Scanned-By: MIMEDefang 2.68 on 10.5.11.27 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.31]); Mon, 13 Mar 2017 06:18:54 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH for-2.9 33/47] qapi: Improve error message on @NAME: in free-form doc X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: marcandre.lureau@redhat.com, mdroth@linux.vnet.ibm.com Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Signed-off-by: Markus Armbruster Reviewed-by: Eric Blake --- scripts/qapi.py | 17 ++++++----------- tests/qapi-schema/doc-invalid-section.err | 2 +- 2 files changed, 7 insertions(+), 12 deletions(-) diff --git a/scripts/qapi.py b/scripts/qapi.py index ca8d1f0..8d34651 100644 --- a/scripts/qapi.py +++ b/scripts/qapi.py @@ -219,6 +219,11 @@ class QAPIDoc(object): if (in_arg or not self.section.name or not self.section.name.startswith('Example')): line =3D line.strip() + match =3D re.match(r'(@\S+:)', line) + if match: + raise QAPIParseError(self.parser, + "'%s' not allowed in free-form documentat= ion" + % match.group(1)) # TODO Drop this once the dust has settled if (isinstance(self.section, QAPIDoc.ArgSection) and '#optional' in line): @@ -970,14 +975,6 @@ def check_exprs(exprs): return exprs =20 =20 -def check_freeform_doc(doc): - body =3D str(doc.body) - if re.search(r'@\S+:', body, re.MULTILINE): - raise QAPISemError(doc.info, - "Free-form documentation block must not contain" - " @NAME: sections") - - def check_definition_doc(doc, expr, info): for i in ('enum', 'union', 'alternate', 'struct', 'command', 'event'): if i in expr: @@ -1016,9 +1013,7 @@ def check_docs(docs): raise QAPISemError(doc.info, "Empty doc section '%s'" % section.name) =20 - if not doc.expr: - check_freeform_doc(doc) - else: + if doc.expr: check_definition_doc(doc, doc.expr, doc.info) =20 return docs diff --git a/tests/qapi-schema/doc-invalid-section.err b/tests/qapi-schema/= doc-invalid-section.err index 85bb67b..bda93b4 100644 --- a/tests/qapi-schema/doc-invalid-section.err +++ b/tests/qapi-schema/doc-invalid-section.err @@ -1 +1 @@ -tests/qapi-schema/doc-invalid-section.json:3: Free-form documentation bloc= k must not contain @NAME: sections +tests/qapi-schema/doc-invalid-section.json:5:1: '@note:' not allowed in fr= ee-form documentation --=20 2.7.4