From nobody Wed Aug 26 10:42:29 2026 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=quarantine dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1781151911; cv=none; d=zohomail.com; s=zohoarc; b=SBkiRrjIEULKGxHIJ7T468Q5fn176OgZB4Cmd/cXpxycRhvBYF6TUkvwkIcwCJvfUzdfVAUe9VQCihwckF7/XPzGqgGkTKSqh51HpAj5MYNMUY7FRjfTaDpTZdpSgv7jgbjrV8HovouLvhDn8yGlU1eOVhuwfGonNGeFeiAFq/Y= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1781151911; h=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=lSo1lqn68UhenL7oYBn7w1Z0vR4YGWD3FV+n9trUE2E=; b=Mdv2zY+cn9wXjL9u2hDIbzWL64M+9cQKla5I/dfs+idXbg6XR+yAeo+ZV0khkmVJZICS462sIP71+355mb1arQZ+I/6CoyY0NHw/wDiYVfiNtzU+jXYkcLGMSnoluOTOOxFuYY5kke2HFqtA4ah9it+rgPDv72GnK04gOZStWjc= 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=quarantine dis=none) Return-Path: Received: from lists1p.gnu.org (lists1p.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1781151911388912.5958975227875; Wed, 10 Jun 2026 21:25:11 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists1p.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1wXWyO-0006ri-QH; Thu, 11 Jun 2026 00:24:56 -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 1wXWyN-0006qT-HR for qemu-devel@nongnu.org; Thu, 11 Jun 2026 00:24:55 -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 1wXWyM-0005be-39 for qemu-devel@nongnu.org; Thu, 11 Jun 2026 00:24:55 -0400 Received: from mx-prod-mc-03.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-433-9OcywcDvP3W4CYAqL6ZfZA-1; Thu, 11 Jun 2026 00:24:39 -0400 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-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 9E77318D97F0; Thu, 11 Jun 2026 04:24:36 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.80.2]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id B4FA01800583; Thu, 11 Jun 2026 04:24:32 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1781151893; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=lSo1lqn68UhenL7oYBn7w1Z0vR4YGWD3FV+n9trUE2E=; b=KxZVs/uabuXwNF6RafdIUQ1dUK20C1OF4NmWzQsZHeFJ28DVJwQuNXFiX/unH3EsCiiYaI zK3Vk4D3bjp+xZM18JpeejwXgwkqIXvDCXXkwhWkTz5/avDcrmBdzICs1UgDpAWZEclUNt GACUgemMzaf0UWV6TjklaTjvTBjuXmc= X-MC-Unique: 9OcywcDvP3W4CYAqL6ZfZA-1 X-Mimecast-MFC-AGG-ID: 9OcywcDvP3W4CYAqL6ZfZA_1781151876 From: John Snow To: qemu-devel@nongnu.org Cc: =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Michael Roth , Eric Blake , "Michael S. Tsirkin" , Markus Armbruster , linux-edac@vger.kernel.org, John Snow , Gerd Hoffmann , Mauro Carvalho Chehab , Pierrick Bouvier , Igor Mammedov , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Paolo Bonzini , Ani Sinha , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Cleber Rosa , Peter Maydell , Richard Henderson Subject: [PATCH v4 11/13] qapi/docs: remove implicit Plain section Date: Thu, 11 Jun 2026 00:23:30 -0400 Message-ID: <20260611042332.482979-12-jsnow@redhat.com> In-Reply-To: <20260611042332.482979-1-jsnow@redhat.com> References: <20260611042332.482979-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.93 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=lists1p.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: 8 X-Spam_score: 0.8 X-Spam_bar: / X-Spam_report: (0.8 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.445, 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_H3=0.001, RCVD_IN_MSPIKE_WL=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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1781151912847158500 Content-Type: text/plain; charset="utf-8" Prior to this patch, we always create an empty Plain section. Removing this allows us to gradually phase out the "Plain" section in favor of "Intro" and "Details" sections while keeping "Plain" around for the interim churn during the series - meaning that we don't actually know at __init__ time which type of section we'll have first. Signed-off-by: John Snow --- scripts/qapi/parser.py | 4 +--- tests/qapi-schema/doc-good.out | 14 -------------- 2 files changed, 1 insertion(+), 17 deletions(-) diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index 09720a2c270..b7a7b9465a9 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -730,9 +730,7 @@ def __init__(self, info: QAPISourceInfo, symbol: Option= al[str] =3D None): # definition doc's symbol, None for free-form doc self.symbol: Optional[str] =3D symbol # the sections in textual order - self.all_sections: List[QAPIDoc.Section] =3D [ - QAPIDoc.Section(info, QAPIDoc.Kind.PLAIN) - ] + self.all_sections: List[QAPIDoc.Section] =3D [] # dicts mapping parameter/feature names to their description self._args: Dict[str, QAPIDoc.ArgSection] =3D {} self._features: Dict[str, QAPIDoc.ArgSection] =3D {} diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index b9829e2f841..16f44221771 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -106,8 +106,6 @@ Examples: - *verbatim* - {braces} doc symbol=3DEnum - Plain - Member=3Done The _one_ {and only}, description on the same line Member=3Dtwo @@ -119,8 +117,6 @@ a member feature Plain @two is undocumented doc symbol=3DBase - Plain - Member=3Dbase1 description starts on a new line, minimally indented @@ -138,16 +134,10 @@ a feature Feature=3Dmember-feat a member feature doc symbol=3DVariant2 - Plain - doc symbol=3DObject - Plain - Feature=3Dunion-feat1 a feature doc symbol=3DAlternate - Plain - Member=3Di description starts on the same line remainder indented the same @@ -161,8 +151,6 @@ doc freeform Another subsection =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D doc symbol=3Dcmd - Plain - Member=3Darg1 description starts on a new line, indented @@ -223,7 +211,5 @@ another feature =20 <- ... has no title ... doc symbol=3DEVT_BOXED - Plain - Feature=3Dfeat3 a feature --=20 2.54.0