From nobody Sat May 10 00:10:07 2025
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=1736881231; cv=none;
d=zohomail.com; s=zohoarc;
b=aqLD99H7aEw2py3tTW7G2Ih9J5ewc7OOIuTjOLcLtzAmc4/Jd1JymI3roqv67kbJcP4QmmpKbCAnLVwSqzfvPSHw9iEvlMZ9zpag2svP0FEf25Dag2Keh9+a8mtmBqkt/MoyxrqBmpMs4wog+37Y90CHAK3MRdFQeW2kuZp1Hi4=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com;
s=zohoarc;
t=1736881231;
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=SThRGMaOFPiU5B+plPpV6JnVjGoZU8XQlyx7zPJdysM=;
b=aMSWoOeQ9kfkjJU8He9SK46IX2KBqTXzoiM4RMI2mHh5yKDMbtpwW8MLQScTCvelJh80x5kWJ0QVbiVjSzZOQdPUA64MwwdabGh2oSP8iWDF+N1VSZdZx1laLJr4nGRsnssPS2oH+0ZVSGT3TLH4sRwC9ZIxYbLb/OkLQs54t84=
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=<jsnow@redhat.com> (p=none dis=none)
Return-Path: <qemu-devel-bounces+importer=patchew.org@nongnu.org>
Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by
mx.zohomail.com
with SMTPS id 17368812318900.09489559482506138;
Tue, 14 Jan 2025 11:00:31 -0800 (PST)
Received: from localhost ([::1] helo=lists1p.gnu.org)
by lists.gnu.org with esmtp (Exim 4.90_1)
(envelope-from <qemu-devel-bounces@nongnu.org>)
id 1tXm8b-0005lD-QO; Tue, 14 Jan 2025 13:59:45 -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 <jsnow@redhat.com>) id 1tXm7z-0005fV-Cn
for qemu-devel@nongnu.org; Tue, 14 Jan 2025 13:59:06 -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 <jsnow@redhat.com>) id 1tXm7x-0002mI-QR
for qemu-devel@nongnu.org; Tue, 14 Jan 2025 13:59:03 -0500
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-640-2WMD4MKtMdye1Nb6UPpHlw-1; Tue,
14 Jan 2025 13:59:00 -0500
Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com
(mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12])
(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 0565B1956056; Tue, 14 Jan 2025 18:58:59 +0000 (UTC)
Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.64.175])
by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP
id EB37519560A3; Tue, 14 Jan 2025 18:58:57 +0000 (UTC)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;
s=mimecast20190719; t=1736881141;
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=SThRGMaOFPiU5B+plPpV6JnVjGoZU8XQlyx7zPJdysM=;
b=LZTB3E2HXZWNNNvnqIcOvULIarKgAn28ssjTM9/V2i0f2uSPWTnkMM3BSdj4qiGd6mefU1
djtsRrZWF1TO3b/RTCWPgFr0BfcVSI3aZHiwOYoqq98sVwcC+1iqRqMY5koCUUNDwFSO0C
QnenEemS3D40LDld6n3NM730e5CAlfs=
X-MC-Unique: 2WMD4MKtMdye1Nb6UPpHlw-1
X-Mimecast-MFC-AGG-ID: 2WMD4MKtMdye1Nb6UPpHlw
From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: Michael Roth <michael.roth@amd.com>,
Peter Maydell <peter.maydell@linaro.org>,
Markus Armbruster <armbru@redhat.com>, John Snow <jsnow@redhat.com>
Subject: [PATCH v2 10/23] docs/qapidoc: add visit_freeform() method
Date: Tue, 14 Jan 2025 13:58:27 -0500
Message-ID: <20250114185840.3058525-11-jsnow@redhat.com>
In-Reply-To: <20250114185840.3058525-1-jsnow@redhat.com>
References: <20250114185840.3058525-1-jsnow@redhat.com>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12
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.133.124; envelope-from=jsnow@redhat.com;
helo=us-smtp-delivery-124.mimecast.com
X-Spam_score_int: -39
X-Spam_score: -4.0
X-Spam_bar: ----
X-Spam_report: (-4.0 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.063,
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=-1.794,
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: <qemu-devel.nongnu.org>
List-Unsubscribe: <https://lists.nongnu.org/mailman/options/qemu-devel>,
<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>
List-Archive: <https://lists.nongnu.org/archive/html/qemu-devel>
List-Post: <mailto:qemu-devel@nongnu.org>
List-Help: <mailto:qemu-devel-request@nongnu.org?subject=help>
List-Subscribe: <https://lists.nongnu.org/mailman/listinfo/qemu-devel>,
<mailto:qemu-devel-request@nongnu.org?subject=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: 1736881232893019000
Content-Type: text/plain; charset="utf-8"
Signed-off-by: John Snow <jsnow@redhat.com>
---
docs/sphinx/qapidoc.py | 47 ++++++++++++++++++++++++++++++++++++++++++
1 file changed, 47 insertions(+)
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py
index 658eae3e386..c42cc3705aa 100644
--- a/docs/sphinx/qapidoc.py
+++ b/docs/sphinx/qapidoc.py
@@ -133,6 +133,53 @@ def visit_module(self, path: str) -> None:
self.add_line_raw(f".. qapi:module:: {name}", path, 1)
self.ensure_blank_line()
=20
+ def visit_freeform(self, doc) -> None:
+ # TODO: Once the old qapidoc transformer is deprecated, freeform
+ # sections can be updated to pure rST, and this transformed remove=
d.
+ #
+ # For now, translate our micro-format into rST. Code adapted
+ # from Peter Maydell's freeform().
+
+ assert len(doc.all_sections) =3D=3D 1, doc.all_sections
+ body =3D doc.all_sections[0]
+ text =3D body.text
+ info =3D doc.info
+
+ if re.match(r"=3D+ ", text):
+ # Section/subsection heading (if present, will always be the
+ # first line of the block)
+ (heading, _, text) =3D text.partition("\n")
+ (leader, _, heading) =3D heading.partition(" ")
+ level =3D len(leader) + 1 # Implicit +1 for heading in .rST s=
tub
+
+ # https://www.sphinx-doc.org/en/master/usage/restructuredtext/=
basics.html#sections
+ markers =3D {
+ 1: "#",
+ 2: "*",
+ 3: "=3D",
+ 4: "-",
+ 5: "^",
+ 6: '"',
+ }
+ overline =3D level <=3D 2
+ marker =3D markers[level]
+
+ self.ensure_blank_line()
+ # This credits all 2 or 3 lines to the single source line.
+ if overline:
+ self.add_line(marker * len(heading), info)
+ self.add_line(heading, info)
+ self.add_line(marker * len(heading), info)
+ self.ensure_blank_line()
+
+ # Eat blank line(s) and advance info
+ trimmed =3D text.lstrip("\n")
+ text =3D trimmed
+ info =3D info.next_line(len(text) - len(trimmed) + 1)
+
+ self.add_lines(text, info)
+ self.ensure_blank_line()
+
=20
# Disable black auto-formatter until re-enabled:
# fmt: off
--=20
2.47.1