From nobody Tue Nov 26 10:42:29 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=1708944913; cv=none; d=zohomail.com; s=zohoarc; b=kBTIf7xOlZO5o8kVvSnPijezZLi1r5H4VnhEfyXuwG4ce05b8T7wm1vHhl88Lv4GqJBZFtXk+bCW0V0UHnt0ryffAC6pBKe5d+nDG6uKWLuPpqeY+3RreikTmbKFRg9HkYLuiEuSkDwMcQMyfWGQLNff3YVdVky1RvZS70b6oqg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1708944913; 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=fGjWcbnRDrafVL+gPn1YGVCIw7yG/XxNC4mi7ogESDA=; b=i9dOMlfSdQWE1KyxhBZEC+wmE/9F4R0MT8QxSGyOHEvar2PdfCIpDYECK23/FDfot8f5eEbz151/wJ8QRe3ds+AZ4hBSnZ9OzGm1vpkIYezz5fzGKr5plSUwlAc9hG1RFoMFM4HVX0blpoHTQM60xaw/a1QFJyOwCxtSjOfjyUs= 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 170894491384360.854676661945064; Mon, 26 Feb 2024 02:55:13 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1reYZI-0002pD-2m; Mon, 26 Feb 2024 05:50:44 -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 1reYYi-0002bu-Lj for qemu-devel@nongnu.org; Mon, 26 Feb 2024 05:50:14 -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 1reYYc-0003jf-1f for qemu-devel@nongnu.org; Mon, 26 Feb 2024 05:50:08 -0500 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-101-2V1JKz0oPTiXkDofIwR8HQ-1; Mon, 26 Feb 2024 05:49:57 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) (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 E4F53882086; Mon, 26 Feb 2024 10:49:56 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.193.4]) by smtp.corp.redhat.com (Postfix) with ESMTPS id C0C1E40C94A8; Mon, 26 Feb 2024 10:49:56 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id A0E2F21E5A41; Mon, 26 Feb 2024 11:49:54 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1708944600; 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=fGjWcbnRDrafVL+gPn1YGVCIw7yG/XxNC4mi7ogESDA=; b=Kv1+VrgU5pIi39Dzj61TAFjXXso7dXgw1zjgzhdlEk0GMIbpnyUZrHqeQi1i39TbxNypuP w+sCBdi5JR6ixV9Usl5yU9XimkrXV3T+GPTFoNYl5/qB09BxOAea9nw3t43Shr0r5PczU3 EWbDWiCuD3q0XoHyWC/MNUf5130RLsQ= X-MC-Unique: 2V1JKz0oPTiXkDofIwR8HQ-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: peter.maydell@linaro.org, =?UTF-8?q?Daniel=20P=20=2E=20Berrang=C3=A9?= Subject: [PULL 10/17] qapi: Reject section heading in the middle of a doc comment Date: Mon, 26 Feb 2024 11:49:47 +0100 Message-ID: <20240226104954.3781985-11-armbru@redhat.com> In-Reply-To: <20240226104954.3781985-1-armbru@redhat.com> References: <20240226104954.3781985-1-armbru@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.2 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: -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.097, 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: 1708944914974100009 docs/devel/qapi-code-gen.txt claims "A heading line must be the first line of the documentation comment block" since commit 55ec69f8b16 (docs/devel/qapi-code-gen.txt: Update to new rST backend conventions). Not true, we have code to make it work anywhere in a free-form doc comment: commit dcdc07a97cb (qapi: Make section headings start a new doc comment block). Make it true, for simplicity's sake. Signed-off-by: Markus Armbruster Message-ID: <20240216145841.2099240-10-armbru@redhat.com> Reviewed-by: Daniel P. Berrang=C3=A9 --- scripts/qapi/parser.py | 6 +++--- tests/qapi-schema/doc-good.json | 4 +++- tests/qapi-schema/doc-non-first-section.err | 1 + tests/qapi-schema/doc-non-first-section.json | 6 ++++++ tests/qapi-schema/doc-non-first-section.out | 0 5 files changed, 13 insertions(+), 4 deletions(-) create mode 100644 tests/qapi-schema/doc-non-first-section.err create mode 100644 tests/qapi-schema/doc-non-first-section.json create mode 100644 tests/qapi-schema/doc-non-first-section.out diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index cc69f4f770..3aefec1c2b 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -440,9 +440,9 @@ def get_doc(self, info: QAPISourceInfo) -> List['QAPIDo= c']: self, "unexpected '=3D' markup in definition documentati= on") if cur_doc.body.text: - cur_doc.end_comment() - docs.append(cur_doc) - cur_doc =3D QAPIDoc(self, info) + raise QAPIParseError( + self, + "'=3D' heading must come first in a comment block") cur_doc.append(self.val) self.accept(False) =20 diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.j= son index 24a84fe6d7..0479d16a01 100644 --- a/tests/qapi-schema/doc-good.json +++ b/tests/qapi-schema/doc-good.json @@ -9,7 +9,9 @@ =20 ## # =3D Section -# +## + +## # =3D=3D Subsection # # *with emphasis* diff --git a/tests/qapi-schema/doc-non-first-section.err b/tests/qapi-schem= a/doc-non-first-section.err new file mode 100644 index 0000000000..eeced2bca7 --- /dev/null +++ b/tests/qapi-schema/doc-non-first-section.err @@ -0,0 +1 @@ +doc-non-first-section.json:5:1: '=3D' heading must come first in a comment= block diff --git a/tests/qapi-schema/doc-non-first-section.json b/tests/qapi-sche= ma/doc-non-first-section.json new file mode 100644 index 0000000000..1590876061 --- /dev/null +++ b/tests/qapi-schema/doc-non-first-section.json @@ -0,0 +1,6 @@ +# =3D section must be first line + +## +# +# =3D Not first +## diff --git a/tests/qapi-schema/doc-non-first-section.out b/tests/qapi-schem= a/doc-non-first-section.out new file mode 100644 index 0000000000..e69de29bb2 --=20 2.43.0