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 8823FC98302 for ; Wed, 23 Sep 2026 06:36:04 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists1p.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1x9GZr-0003oJ-Uo; Wed, 23 Sep 2026 02:35:36 -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 1x9GZi-0003m0-Km for qemu-devel@nongnu.org; Wed, 23 Sep 2026 02:35:27 -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 1x9GZg-0002VT-35 for qemu-devel@nongnu.org; Wed, 23 Sep 2026 02:35:26 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1790145323; 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=DvIvf2JwXmc4QuIPZQODeq/jorQSoA6q8DCoE1xhHJ8=; b=SGd8i7ZM1E3qt4LpZwXDZ6jgA+Rw6pY16Two07sBI8PbsLxDmeg35g1jjabN6eU3wGeMrK dWlz+IJKr5i8NEIznS/2/yZkb2X6Yae2z1OTLMeQk1TOEkToXB6hph9zjnUuBHshG07Mub nQtYzDTLBUMZkKjhU9qt4RC6m52qHAU= Received: from mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-581-7teolsdMN1S1LICnKu1meA-1; Wed, 23 Sep 2026 02:35:19 -0400 X-MC-Unique: 7teolsdMN1S1LICnKu1meA-1 X-Mimecast-MFC-AGG-ID: 7teolsdMN1S1LICnKu1meA_1790145317 Received: from mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.4]) (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-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id E069C18005B8; Wed, 23 Sep 2026 06:35:16 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.44.22.5]) by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 1E04A30002C2; Wed, 23 Sep 2026 06:35:16 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id ABBF621E6A04; Wed, 23 Sep 2026 08:35:13 +0200 (CEST) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, Michael Roth , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , Kashyap Chamarthy , Kevin Wolf , Michael Tokarev , Hanna Reitz , Stefano Garzarella , Jason Wang , Zhao Liu , Kostiantyn Kostiuk , Philippe =?utf-8?Q?Mathieu-Da?= =?utf-8?Q?ud=C3=A9?= , qemu-block@nongnu.org, qemu-trivial@nongnu.org, Laurent Vivier , Eric Blake , "Michael S. Tsirkin" , Pierrick Bouvier Subject: Re: [PATCH 2/9] qapi: convert intro sections for unit tests In-Reply-To: (John Snow's message of "Tue, 22 Sep 2026 13:29:12 -0400") References: <20260921205147.1857168-1-jsnow@redhat.com> <20260921205147.1857168-3-jsnow@redhat.com> <87a4p92p3k.fsf@pond.sub.org> Date: Wed, 23 Sep 2026 08:35:13 +0200 Message-ID: <878q4szd9a.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) 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.30.177.4 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: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, 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_PASS=-0.001, SPF_PASS=-0.001 autolearn=unavailable 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: > On Tue, Sep 22, 2026 at 1:06=E2=80=AFPM Markus Armbruster wrote: >> >> John Snow writes: >> >> > Signed-off-by: John Snow >> > --- >> > tests/qapi-schema/doc-good.json | 10 +++++----- >> > tests/qapi-schema/doc-good.out | 13 +++++-------- >> > tests/qapi-schema/doc-interleaved-section.err | 2 +- >> > tests/qapi-schema/doc-interleaved-section.json | 3 +-- >> > 4 files changed, 12 insertions(+), 16 deletions(-) >> > >> > diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-g= ood.json >> > index fac13425b72..00721d5c522 100644 >> > --- a/tests/qapi-schema/doc-good.json >> > +++ b/tests/qapi-schema/doc-good.json >> > @@ -94,12 +94,11 @@ >> > >> > ## >> > # @Variant1: >> > +# A paragraph >> > # >> > -# A paragraph >> > +# Another paragraph >> > # >> > -# Another paragraph >> > -# >> > -# @var1 is undocumented >> > +# @var1 is undocumented >> >> Let's keep '@var1 is undocumented' plain. That way, it stays close to >> "author forgot the colon after the member name", which I find useful. > > OK, but it will very soon be disallowed in that position; it will have > to be moved below Features et al, eventually. Making this change, but > heads up that it necessitates another patch in the order enforcement > series. Yes. >> > # >> > # Features: >> > # @variant1-feat: a feature >> > @@ -206,7 +205,8 @@ >> > >> > ## >> > # @cmd-boxed: >> > -# If you're bored enough to read this, go see a video of boxed cats >> > +# If you're bored enough to read this, go see a video of boxed >> > +# cats >> > # >> > # Features: >> > # @cmd-feat1: a feature >> > diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-go= od.out >> > index 371dd25ffc7..8c0818a3f0d 100644 >> > --- a/tests/qapi-schema/doc-good.out >> > +++ b/tests/qapi-schema/doc-good.out >> > @@ -126,13 +126,11 @@ doc symbol=3DBase >> > minimally indented >> > doc symbol=3DVariant1 >> > Intro >> > + A paragraph >> > >> > - Plain >> > -A paragraph >> > + Another paragraph >> > >> > -Another paragraph >> > - >> > -@var1 is undocumented >> > + @var1 is undocumented >> > Member=3Dvar1 >> > >> > Feature=3Dvariant1-feat >> > @@ -213,9 +211,8 @@ Note:: >> > 2.10 >> > doc symbol=3Dcmd-boxed >> > Intro >> > - >> > - Plain >> > -If you're bored enough to read this, go see a video of boxed cats >> > + If you're bored enough to read this, go see a video of boxed >> > + cats >> > Feature=3Dcmd-feat1 >> > a feature >> > Feature=3Dcmd-feat2 >> >> I'm mildly surprised that the intro's indentation isn't stripped. Maybe >> we discussed that already, and I forgot. Anyway, it works, and changing >> it is way out of scope right now. > > *searching resident databanks* > > I think I was striving for minimal processing of the text prior to > handoff to sphinx for reasons of preserving accurate source > information. > > qapidoc.py has this code: > ``` > def visit_plaintext(self, section: QAPIDoc.Section) -> None: > # Squelch empty paragraphs. > if not section.text: > return > > # Intro sections, which are indented in QAPI source, need to > # be dedented to avoid accidental block quotes in ReST syntax. > dedent =3D bool(section.kind =3D=3D QAPIDoc.Kind.INTRO) > self.ensure_blank_line() > self.add_lines(section.text, section.info, dedent) > self.ensure_blank_line() > ``` > > As a result, the unit test plaintext versions retain that indentation. > This actually matches how we treat indentation for member text, which > is also preserved and represented in the plaintext test output! > > Granted, now that I have excised the backwards compatibility demon > from qapidoc, it is possible we can conduct another audit on source > information preservation and some things might be able to be > simplified, but I think this is fine and good for now. Maybe, eventually. You got far more interesting work piled up that I want to merge. [...]