From nobody Sun Feb 8 20:58:55 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; 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=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1599548166; cv=none; d=zohomail.com; s=zohoarc; b=GQDii89JQijg1RCKlKSjnc7dxD4WGVsUI1XGxdypPIJB+qyXal/kvWVCSPcBv3V9HYWEfTOBx3OnOlKJYTVV6Y1QBJCOPpKK6pEUuq51OIrwGuyqrRdxIs0aviNN6JsyF/nEAiJ4yDRGymEIH1bo5ETzfyWNJBtVMCd6n2r9NDA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1599548166; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=E0JZAzMlL7Xkk0++eImXbAXLot8IjA6/k/Y9LtwGs8Q=; b=jp9hplVBqhgsIqauRhGzumP8KZFQsOfuYaH7aa2dbRK2oYYVZ6Soy7DksZq+I2PXRy/MT5UBBnXMa6h7Uq/w7BJI0RmjOFD1ZayIVQpqXZPB20M8nLiGefborNc3/E/RcddRVqcgHBgvvUg7fjbHVFvdlafqFNfy+/xBbgjznj4= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; 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=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1599548166915963.8302898213144; Mon, 7 Sep 2020 23:56:06 -0700 (PDT) Received: from localhost ([::1]:39942 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kFXXx-00030L-Es for importer@patchew.org; Tue, 08 Sep 2020 02:56:05 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:43480) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kFXWM-0001Fb-Sx for qemu-devel@nongnu.org; Tue, 08 Sep 2020 02:54:26 -0400 Received: from us-smtp-delivery-1.mimecast.com ([205.139.110.120]:46574 helo=us-smtp-1.mimecast.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kFXWJ-0008CX-RU for qemu-devel@nongnu.org; Tue, 08 Sep 2020 02:54:26 -0400 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-84-xC50Hkq6NxKbXlQiOnywWg-1; Tue, 08 Sep 2020 02:54:20 -0400 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 88917802B79; Tue, 8 Sep 2020 06:54:19 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-113-68.ams2.redhat.com [10.36.113.68]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 3F01B5C1C4; Tue, 8 Sep 2020 06:54:19 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 852D611329B4; Tue, 8 Sep 2020 08:54:17 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1599548062; 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=E0JZAzMlL7Xkk0++eImXbAXLot8IjA6/k/Y9LtwGs8Q=; b=FiKQoBnFX6wfDQAb1tAJRMpWq1Lhz0daIvxCrkhMpBiXJQBIb5H9r1kPQbXxvKg5829lzO E3/KRjOEup2VVJzFIAFrR4/V/zUhUv6vs0fAtklZjEW+nCzZVJH7zl61J0qoe6vqGhgHqA aYGLqKe0ii3StM/F7814exFF3Aw5y1c= X-MC-Unique: xC50Hkq6NxKbXlQiOnywWg-1 From: Markus Armbruster To: qemu-devel@nongnu.org Subject: [PULL 1/5] qapi: Reject section markup in definition documentation Date: Tue, 8 Sep 2020 08:54:13 +0200 Message-Id: <20200908065417.3158250-2-armbru@redhat.com> In-Reply-To: <20200908065417.3158250-1-armbru@redhat.com> References: <20200908065417.3158250-1-armbru@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=armbru@redhat.com X-Mimecast-Spam-Score: 0.0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable 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=205.139.110.120; envelope-from=armbru@redhat.com; helo=us-smtp-1.mimecast.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/09/08 02:10:53 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] 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.1, 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 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: peter.maydell@linaro.org Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Section markup in definition documentation makes no sense and can produce invalid Texinfo. Reject. Signed-off-by: Markus Armbruster Message-Id: <20200320091805.5585-2-armbru@redhat.com> Reviewed-by: Eric Blake --- docs/devel/qapi-code-gen.txt | 2 ++ scripts/qapi/parser.py | 5 +++++ tests/qapi-schema/doc-bad-section.err | 1 + tests/qapi-schema/doc-bad-section.json | 3 +-- tests/qapi-schema/doc-bad-section.out | 24 ------------------------ 5 files changed, 9 insertions(+), 26 deletions(-) diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt index f3e7ced212..9eede44350 100644 --- a/docs/devel/qapi-code-gen.txt +++ b/docs/devel/qapi-code-gen.txt @@ -835,6 +835,8 @@ Double the '=3D' for a subsection title: =20 # =3D=3D Subsection title =20 +Both are only permitted in free-form documentation. + '|' denotes examples: =20 # | Text of the example, may span diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index abadacbb0e..f12c67d7d2 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -282,6 +282,11 @@ class QAPISchemaParser: doc.end_comment() self.accept() return doc + if self.val.startswith('# =3D'): + if doc.symbol: + raise QAPIParseError( + self, + "unexpected '=3D' markup in definition documentati= on") doc.append(self.val) self.accept(False) =20 diff --git a/tests/qapi-schema/doc-bad-section.err b/tests/qapi-schema/doc-= bad-section.err index e69de29bb2..785cacc08c 100644 --- a/tests/qapi-schema/doc-bad-section.err +++ b/tests/qapi-schema/doc-bad-section.err @@ -0,0 +1 @@ +doc-bad-section.json:5:1: unexpected '=3D' markup in definition documentat= ion diff --git a/tests/qapi-schema/doc-bad-section.json b/tests/qapi-schema/doc= -bad-section.json index 560df4b087..8175d95867 100644 --- a/tests/qapi-schema/doc-bad-section.json +++ b/tests/qapi-schema/doc-bad-section.json @@ -1,9 +1,8 @@ # =3D section within an expression comment -# BUG: not rejected =20 ## # @Enum: -# =3D=3D Produces *invalid* texinfo +# =3D=3D No good here # @one: The _one_ {and only} # # @two is undocumented diff --git a/tests/qapi-schema/doc-bad-section.out b/tests/qapi-schema/doc-= bad-section.out index 367e2a1c3e..e69de29bb2 100644 --- a/tests/qapi-schema/doc-bad-section.out +++ b/tests/qapi-schema/doc-bad-section.out @@ -1,24 +0,0 @@ -module None -object q_empty -enum QType - prefix QTYPE - member none - member qnull - member qnum - member qstring - member qdict - member qlist - member qbool -module doc-bad-section.json -enum Enum - member one - member two -doc symbol=3DEnum - body=3D -=3D=3D Produces *invalid* texinfo - arg=3Done -The _one_ {and only} - arg=3Dtwo - - section=3DNone -@two is undocumented --=20 2.26.2