From nobody Mon Feb 9 09:28:36 2026 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 1489583910922131.5631528659817; Wed, 15 Mar 2017 06:18:30 -0700 (PDT) Received: from localhost ([::1]:37102 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1co8ot-0001lb-Lk for importer@patchew.org; Wed, 15 Mar 2017 09:18:27 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:33565) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1co8Uv-0001Ym-N5 for qemu-devel@nongnu.org; Wed, 15 Mar 2017 08:57:55 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1co8Ur-0000MA-5O for qemu-devel@nongnu.org; Wed, 15 Mar 2017 08:57:49 -0400 Received: from mx1.redhat.com ([209.132.183.28]:36666) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1co8Uq-0000Jp-Po for qemu-devel@nongnu.org; Wed, 15 Mar 2017 08:57:45 -0400 Received: from int-mx09.intmail.prod.int.phx2.redhat.com (int-mx09.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (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 9616BC04BD47; Wed, 15 Mar 2017 12:57:44 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-116-26.ams2.redhat.com [10.36.116.26]) by int-mx09.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id v2FCvhDY028112 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=NO); Wed, 15 Mar 2017 08:57:44 -0400 Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id D7A7711384B6; Wed, 15 Mar 2017 13:57:36 +0100 (CET) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com 9616BC04BD47 Authentication-Results: ext-mx07.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx07.extmail.prod.ext.phx2.redhat.com; spf=pass smtp.mailfrom=armbru@redhat.com DKIM-Filter: OpenDKIM Filter v2.11.0 mx1.redhat.com 9616BC04BD47 From: Markus Armbruster To: qemu-devel@nongnu.org Date: Wed, 15 Mar 2017 13:57:21 +0100 Message-Id: <1489582656-31133-33-git-send-email-armbru@redhat.com> In-Reply-To: <1489582656-31133-1-git-send-email-armbru@redhat.com> References: <1489582656-31133-1-git-send-email-armbru@redhat.com> X-Scanned-By: MIMEDefang 2.68 on 10.5.11.22 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.31]); Wed, 15 Mar 2017 12:57:44 +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 v2 for-2.9 32/47] qapi: Move detection of doc / expression name mismatch 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" Move the check whether the doc matches the expression name from check_definition_doc() to check_exprs(). This changes the error location from the comment to the expression. Makes sense as the message talks about the expression: "Definition of '%s' follows documentation for '%s'". It's also a step towards getting rid of check_docs(). Signed-off-by: Markus Armbruster Reviewed-by: Eric Blake --- scripts/qapi.py | 28 ++++++++++++++++++---------- tests/qapi-schema/doc-bad-symbol.err | 2 +- 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/scripts/qapi.py b/scripts/qapi.py index 37f2814..9a1d830 100644 --- a/scripts/qapi.py +++ b/scripts/qapi.py @@ -894,40 +894,52 @@ def check_keys(expr_elem, meta, required, optional=3D= []): def check_exprs(exprs): global all_names =20 - # Learn the types and check for valid expression keys + # Populate name table with names of built-in types for builtin in builtin_types.keys(): all_names[builtin] =3D 'built-in' + + # Learn the types and check for valid expression keys for expr_elem in exprs: expr =3D expr_elem['expr'] info =3D expr_elem['info'] + doc =3D expr_elem.get('doc') =20 - if 'doc' not in expr_elem and doc_required: + if not doc and doc_required: raise QAPISemError(info, "Expression missing documentation comment") =20 if 'enum' in expr: + name =3D expr['enum'] check_keys(expr_elem, 'enum', ['data'], ['prefix']) - add_enum(expr['enum'], info, expr['data']) + add_enum(name, info, expr['data']) elif 'union' in expr: + name =3D expr['union'] check_keys(expr_elem, 'union', ['data'], ['base', 'discriminator']) add_union(expr, info) elif 'alternate' in expr: + name =3D expr['alternate'] check_keys(expr_elem, 'alternate', ['data']) - add_name(expr['alternate'], info, 'alternate') + add_name(name, info, 'alternate') elif 'struct' in expr: + name =3D expr['struct'] check_keys(expr_elem, 'struct', ['data'], ['base']) add_struct(expr, info) elif 'command' in expr: + name =3D expr['command'] check_keys(expr_elem, 'command', [], ['data', 'returns', 'gen', 'success-response', 'box= ed']) - add_name(expr['command'], info, 'command') + add_name(name, info, 'command') elif 'event' in expr: + name =3D expr['event'] check_keys(expr_elem, 'event', [], ['data', 'boxed']) - add_name(expr['event'], info, 'event') + add_name(name, info, 'event') else: raise QAPISemError(expr_elem['info'], "Expression is missing metatype") + if doc and doc.symbol !=3D name: + raise QAPISemError(info, "Definition of '%s' follows documenta= tion" + " for '%s'" % (name, doc.symbol)) =20 # Try again for hidden UnionKind enum for expr_elem in exprs: @@ -977,10 +989,6 @@ def check_definition_doc(doc, expr, info): meta =3D i break =20 - name =3D expr[meta] - if doc.symbol !=3D name: - raise QAPISemError(info, "Definition of '%s' follows documentation" - " for '%s'" % (name, doc.symbol)) if doc.has_section('Returns') and 'command' not in expr: raise QAPISemError(info, "'Returns:' is only valid for commands") =20 diff --git a/tests/qapi-schema/doc-bad-symbol.err b/tests/qapi-schema/doc-b= ad-symbol.err index ac4e566..8472030 100644 --- a/tests/qapi-schema/doc-bad-symbol.err +++ b/tests/qapi-schema/doc-bad-symbol.err @@ -1 +1 @@ -tests/qapi-schema/doc-bad-symbol.json:3: Definition of 'foo' follows docum= entation for 'food' +tests/qapi-schema/doc-bad-symbol.json:6: Definition of 'foo' follows docum= entation for 'food' --=20 2.7.4