From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists1p.gnu.org (lists1p.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 01AB3CA5FA1 for ; Tue, 29 Sep 2026 12:37:17 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists1p.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1xBX4X-0002MO-UK; Tue, 29 Sep 2026 08:36:38 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists1p.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1xBX4M-0002Jw-JW for qemu-devel@nongnu.org; Tue, 29 Sep 2026 08:36:26 -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 1xBX4K-0005sO-6G for qemu-devel@nongnu.org; Tue, 29 Sep 2026 08:36:25 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1790685382; 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: in-reply-to:in-reply-to:references:references; bh=+m+fq3JAkJR53BkngXMFwhygEIKOtnQi+rON2RDJPuY=; b=gSD0KyvaDedNjCh6bpw3QVaTqu48OQ9l/UMnpRgWGzzkNHyC7aBtzcThcVbMjOUFKnsN8p hv2zjnlmCL93+ZbWYTJhCZNrmxgw8rJLiFiqRZuOMOjsxJtR+YNxx9adGJ+tMo+RT2cwKM 3GYo95uYQOhnNS0UroR69cIUKevm9Ew= Received: from mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-575-69g9a1rAOjaaKyEbHVy0Mg-1; Tue, 29 Sep 2026 08:36:18 -0400 X-MC-Unique: 69g9a1rAOjaaKyEbHVy0Mg-1 X-Mimecast-MFC-AGG-ID: 69g9a1rAOjaaKyEbHVy0Mg_1790685375 Received: from mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.93]) (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 mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 9CD5419792EE; Tue, 29 Sep 2026 12:36:11 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.44.22.5]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id D2522180057F; Tue, 29 Sep 2026 12:36:09 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 6F4D721E6A04; Tue, 29 Sep 2026 14:36:07 +0200 (CEST) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, Peter Xu , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , Stefan Berger , Fabiano Rosas , Hanna Reitz , Paolo Bonzini , Zhao Liu , Kevin Wolf , Ani Sinha , Pierrick Bouvier , Jiri Pirko , Alex Williamson , Kashyap Chamarthy , Peter Maydell , Kostiantyn Kostiuk , Stefan Hajnoczi , Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= , Michael Roth , Mauro Carvalho Chehab , Vladimir Sementsov-Ogievskiy , =?utf-8?Q?Marc-Andr=C3=A9?= Lureau , qemu-block@nongnu.org, =?utf-8?Q?C=C3=A9?= =?utf-8?Q?dric?= Le Goater , Stefano Garzarella , Richard Henderson , "Michael S. Tsirkin" , Igor Mammedov , Jason Wang , Alex =?utf-8?Q?Benn=C3=A9e?= , Eric Blake Subject: Re: [PATCH 04/14] qapi/parser: enforce doc block section ordering In-Reply-To: <20260928223657.2303684-5-jsnow@redhat.com> (John Snow's message of "Mon, 28 Sep 2026 18:36:47 -0400") References: <20260928223657.2303684-1-jsnow@redhat.com> <20260928223657.2303684-5-jsnow@redhat.com> Date: Tue, 29 Sep 2026 14:36:07 +0200 Message-ID: <87bj9gxmiw.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.93 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: 9 X-Spam_score: 0.9 X-Spam_bar: / X-Spam_report: (0.9 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.341, 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, RCVD_IN_SBL_CSS=3.335, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: qemu development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org John Snow writes: > Enforce the relative ordering of "Intro", "Members", "Features", > "Errors" and "Returns" sections. > > Signed-off-by: John Snow > --- > docs/devel/qapi-code-gen.rst | 19 +++++++++++------ > scripts/qapi/parser.py | 41 ++++++++++++++++++++++++++++++------ > 2 files changed, 48 insertions(+), 12 deletions(-) > > diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst > index 3ac1c2dae18..29e9c5a3da6 100644 > --- a/docs/devel/qapi-code-gen.rst > +++ b/docs/devel/qapi-code-gen.rst > @@ -985,12 +985,19 @@ When documentation is required (see pragma_ 'doc-required'), every > definition must have documentation. > > Definition documentation starts with a description naming the > -definition with an optional indented overview (the "intro"), > -:ref:`descriptions ` of each argument (for commands and > -events), member (for structs and unions), branch (for alternates), or > -value (for enums), :ref:`feature descriptions ` of each > -feature (if any), and finally optional :ref:`tagged sections > -`. > +definition with an optional indented overview (the "intro"). > + > +The introduction is followed by :ref:`descriptions ` of > +each argument (for commands and events), member (for structs and > +unions), branch (for alternates), or value (for enums). > + > +:ref:`Tagged sections ` follow in order: Returns (for > +commands), Errors (for commands), and lastly :ref:`feature > +descriptions ` if applicable. *Some* of the tagged sections do. Does this document still need the concept "tagged section"? > + > +Definition documentation concludes with rST-formatted detail > +paragraphs (including examples, notes, &c), and finally an optional > +"Since" tagged section at the very end. > > .. _doc-descrip: > > diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py > index fe284a3f866..94a60a23482 100644 > --- a/scripts/qapi/parser.py > +++ b/scripts/qapi/parser.py > @@ -545,6 +545,28 @@ def get_doc(self) -> 'QAPIDoc': > doc.all_sections.append(QAPIDoc.Section(info, QAPIDoc.Kind.INTRO)) > line = self.get_doc_indented(doc) > no_more_args = False > + last_ordered_section = QAPIDoc.Kind.INTRO > + > + def _tag_check(this: Union['QAPIDoc.Kind', str]) -> None: > + nonlocal last_ordered_section > + if isinstance(this, str): > + this = QAPIDoc.Kind.from_string(this) Simpler, I think: require a .Kind argument, and do the conversion from string in the one caller that needs it. > + > + if this in (QAPIDoc.Kind.TODO, QAPIDoc.Kind.SINCE, > + QAPIDoc.Kind.DETAILS): > + return > + > + if this.value < last_ordered_section.value: > + raise QAPIParseError( > + self, > + f"'{this}' section cannot appear after " > + f"'{last_ordered_section}' section, please re-order " > + "the sections and adjust phrasing as necessary to " > + "ensure consistent documentation flow between the " > + "source code and the rendered HTML manual" > + ) That's a loooong error message. It actually consists of the error proper and advice on how to correct it. Please use "\n" like we do in expr.py's check_keys(), parser.py's ._validate_doc_line_format(), and schema.py's ._def_definition(). Yes, the embedded newline is a bit of a hack. > + > + last_ordered_section = this > > while line is not None: > # Blank lines > @@ -558,6 +580,7 @@ def get_doc(self) -> 'QAPIDoc': > if doc.has_features: > raise QAPIParseError( > self, "duplicated 'Features:' line") > + _tag_check(QAPIDoc.Kind.FEATURE) > self.accept(False) > line = self.get_doc_line() > while line == '': > @@ -581,6 +604,7 @@ def get_doc(self) -> 'QAPIDoc': > self, > "description of '@%s:' follows a section" > % match.group(1)) > + _tag_check(QAPIDoc.Kind.MEMBER) > while (line is not None > and (match := self._match_at_name_colon(line))): > doc.new_argument(self.info, match.group(1)) > @@ -621,6 +645,7 @@ def get_doc(self) -> 'QAPIDoc': > ) > raise QAPIParseError(self, emsg) > > + _tag_check(match.group(1)) This is the caller that needs it. > doc.new_tagged_section( > self.info, > QAPIDoc.Kind.from_string(match.group(1)) > @@ -632,6 +657,7 @@ def get_doc(self) -> 'QAPIDoc': > no_more_args = True > else: > # plain paragraph(s) > + _tag_check(QAPIDoc.Kind.DETAILS) > doc.ensure_untagged_section(self.info) > doc.append_line(line) > line = self.get_doc_paragraph(doc) > @@ -674,14 +700,17 @@ class QAPIDoc: > """ > > class Kind(enum.Enum): > - DETAILS = 0 > + # The order here is the order in which sections must appear in > + # source code; with the exception of 'TODO' which may appear > + # anywhere but is treated as a comment. > + INTRO = 0 > MEMBER = 1 > - FEATURE = 2 > - RETURNS = 3 > - ERRORS = 4 > - SINCE = 5 > + RETURNS = 2 > + ERRORS = 3 > + FEATURE = 4 > + DETAILS = 5 > TODO = 6 > - INTRO = 7 > + SINCE = 7 > > @staticmethod > def from_string(kind: str) -> 'QAPIDoc.Kind': Missing: negative test for the new error.