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 lists.gnu.org (lists.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 2D2F5C02198 for ; Wed, 12 Feb 2025 09:07:24 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ti8hW-0005r0-Sa; Wed, 12 Feb 2025 04:06:34 -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 1ti8hV-0005qS-0b for qemu-devel@nongnu.org; Wed, 12 Feb 2025 04:06:33 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ti8hS-0003dW-QQ for qemu-devel@nongnu.org; Wed, 12 Feb 2025 04:06:32 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1739351188; 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=HYZJir5nMKMCJm70aeJOJKhHn4QCutI2WjNR2wesDV0=; b=KTRBrATCbDnFyuhwK7FrOz9Xg5mSvvp4E8xGrHFW3KxEnfxHDq9YcTQU+WT9Zf0/C7n5lC H4x626Rf/x1CHgGh8HjOncn+KDVkrKqVAPVqkeH4Vja0suJff4/kguPH3XZeRqIfMrDJUP 1eyxoXHpTbNECh1oXKEyw/OjHO9xEmY= Received: from mx-prod-mc-04.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-654-fGL8r1kFOzWdBXnfrXFX_Q-1; Wed, 12 Feb 2025 04:06:26 -0500 X-MC-Unique: fGL8r1kFOzWdBXnfrXFX_Q-1 X-Mimecast-MFC-AGG-ID: fGL8r1kFOzWdBXnfrXFX_Q 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-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 39A471955DD0; Wed, 12 Feb 2025 09:06:24 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.45.242.22]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 1F6781800570; Wed, 12 Feb 2025 09:06:22 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id A3D2F21E6A28; Wed, 12 Feb 2025 10:06:19 +0100 (CET) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, Peter Maydell , Thomas Huth , Yanan Wang , Fabiano Rosas , Zhao Liu , Lukas Straub , Eduardo Habkost , Michael Roth , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , Peter Xu , Eric Blake , Marcel Apfelbaum , Alex =?utf-8?Q?Benn=C3=A9e?= , Jason Wang , Paolo Bonzini , Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= Subject: Re: [PATCH 28/42] qapi/parser: prohibit untagged sections between tagged sections In-Reply-To: <20250205231208.1480762-29-jsnow@redhat.com> (John Snow's message of "Wed, 5 Feb 2025 18:11:54 -0500") References: <20250205231208.1480762-1-jsnow@redhat.com> <20250205231208.1480762-29-jsnow@redhat.com> Date: Wed, 12 Feb 2025 10:06:19 +0100 Message-ID: <87ed03r0qc.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.133.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -35 X-Spam_score: -3.6 X-Spam_bar: --- X-Spam_report: (-3.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-1.54, 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_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=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.29 Precedence: list List-Id: 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: > This is being done primarily to ensure consistency between the source > documents and the final, rendered HTML output. Because > member/feature/returns sections will always appear in a visually grouped > element in the HTML output, prohibiting free paragraphs between those > sections ensures ordering consistency between source and the final > render. > > Additionally, prohibiting such "middle" text paragraphs allows us to > classify all plain text sections as either "intro" or "detail" > sections, because these sections must either appear before structured > elements ("intro") or afterwards ("detail"). > > This keeps the inlining algorithm simpler with fewer "splice" points > when inlining multiple documentation blocks. Mention the two "middle" paragraphs you have to eliminate in this patch? > > Signed-off-by: John Snow > --- > qapi/net.json | 4 ++-- > qapi/qom.json | 4 ++-- > scripts/qapi/parser.py | 16 ++++++++++++++++ > tests/qapi-schema/doc-good.json | 4 ++-- > tests/qapi-schema/doc-good.out | 4 ++-- > tests/qapi-schema/doc-good.txt | 8 ++++---- > 6 files changed, 28 insertions(+), 12 deletions(-) > > diff --git a/qapi/net.json b/qapi/net.json > index 2739a2f4233..49bc7de64e9 100644 > --- a/qapi/net.json > +++ b/qapi/net.json > @@ -655,13 +655,13 @@ > # this to zero disables this function. This member is mutually > # exclusive with @reconnect. (default: 0) (Since: 9.2) > # > -# Only SocketAddress types 'unix', 'inet' and 'fd' are supported. > -# > # Features: > # > # @deprecated: Member @reconnect is deprecated. Use @reconnect-ms > # instead. > # > +# Only SocketAddress types 'unix', 'inet' and 'fd' are supported. > +# > # Since: 7.2 > ## > { 'struct': 'NetdevStreamOptions', The text moved applies to member @addr. You're moving it even farther away from @addr. Move it into @addr instead? Could be done as a separate cleanup patch to keep this one as simple as possible; matter of taste. The same text is in NetdevDgramOptions below, where it applies to both @remote and @local. It just happens to follow @remote and @local immediately, because there are no other members and no features. Hmm. Ideally, we'd have a way to put such notes next to the stuff they apply to without having to rely on happy accidents like "no features". Alternatively, have a way to link stuff and note. Footnotes? Food for thought, not demand. > diff --git a/qapi/qom.json b/qapi/qom.json > index 28ce24cd8d0..11277d1f84c 100644 > --- a/qapi/qom.json > +++ b/qapi/qom.json > @@ -195,12 +195,12 @@ > # > # @typename: the type name of an object > # > +# Returns: a list of ObjectPropertyInfo describing object properties > +# > # .. note:: Objects can create properties at runtime, for example to > # describe links between different devices and/or objects. These > # properties are not included in the output of this command. > # > -# Returns: a list of ObjectPropertyInfo describing object properties > -# > # Since: 2.12 > ## This move is fine. Placing notes at the end is more common already. > { 'command': 'qom-list-properties', > diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py > index b2f77ffdd7a..c5d2b950a82 100644 > --- a/scripts/qapi/parser.py > +++ b/scripts/qapi/parser.py > @@ -500,6 +500,20 @@ def get_doc(self) -> 'QAPIDoc': > self.accept(False) > line = self.get_doc_line() > have_tagged = False > + no_more_tags = False > + > + def _tag_check(what: str) -> None: > + if what in ('TODO', 'Since'): > + return > + > + if no_more_tags: > + raise QAPIParseError( > + self, > + f"{what!r} section cannot appear after free " > + "paragraphs that follow other tagged sections. " > + "Move this section upwards with the preceding " > + "tagged sections." > + ) Why !r conversion? Error messages should be a single, short phrase, no punctuation at the end. Sometimes a helpful hint is desirable. Here's one in expr.py: raise QAPISemError( info, "%s has unknown key%s %s\nValid keys are %s." % (source, 's' if len(unknown) > 1 else '', pprint(unknown), pprint(allowed))) Needs a negative test case. Aside: we should probably convert most string interpolation to f-strings en masse at some point. > > while line is not None: > # Blank lines > @@ -513,6 +527,7 @@ def get_doc(self) -> 'QAPIDoc': > if doc.features: > raise QAPIParseError( > self, "duplicated 'Features:' line") > + _tag_check("Features") > self.accept(False) > line = self.get_doc_line() > while line == '': > @@ -576,6 +591,7 @@ def get_doc(self) -> 'QAPIDoc': > ) > raise QAPIParseError(self, emsg) > > + _tag_check(match.group(1)) > doc.new_tagged_section( > self.info, > QAPIDoc.Kind.from_string(match.group(1)) > diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json > index f64bf38d854..14b2091b08f 100644 > --- a/tests/qapi-schema/doc-good.json > +++ b/tests/qapi-schema/doc-good.json > @@ -157,12 +157,12 @@ > # @cmd-feat1: a feature > # @cmd-feat2: another feature > # > -# .. note:: @arg3 is undocumented > -# > # Returns: @Object > # > # Errors: some > # > +# .. note:: @arg3 is undocumented > +# This used to be right next to @arg1 and arg2 (commit 80d1f2e4a5d) until commit 79598c8a634 added features in between. This patch adds more stuff there. Right next is clearly the best spot, but this is just a test, so it doesn't really matter. Related: NetdevDgramOptions' note discussed above. > # TODO: frobnicate > # > # .. admonition:: Notes [...]