From nobody Sat Nov 15 12:16:48 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=quarantine dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1752505998; cv=none; d=zohomail.com; s=zohoarc; b=aSDo0TzyL4CwrM5PuwFHTK/79lS+86DL+iFONLqP63to4v2/gn6xxCgv5ZdDiRzZS/pEZq1x0Yebd0GBNCCMUHrdx9wPmnA2MyrD1wtUNo8OAx7/VePNP3A0ae+sLHKiXB3K27LyrYpROkHMUu3ofWSgDG74R6UyQn+V+goz7a0= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1752505998; 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=3c4K7n3IfwGoNKL5/wNBn8NnRX7qMr6IpHiyT/o7x2k=; b=TY3xIJZejsRKVcaxnYXXPAsjJnP56jPCy87zJPIqBP64PGx8v6pCxPkD3ewhrFsA12K8GG9ZECqpqOXxsx+XDuMzKRN/R/ZZ1znRdJpuKryHfK/myOYQJXGGa5ulzzl+kz5dPOXVDAJh+4q31+qx/hUzxKlPUyODYHy+L85UV64= 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 lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1752505998515688.9693024148638; Mon, 14 Jul 2025 08:13:18 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ubKqm-0007Ov-8S; Mon, 14 Jul 2025 11:12:16 -0400 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 1ubJUV-0000GH-AQ for qemu-devel@nongnu.org; Mon, 14 Jul 2025 09:45:16 -0400 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 1ubJUQ-0003Xu-Dk for qemu-devel@nongnu.org; Mon, 14 Jul 2025 09:45:11 -0400 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-558-I0GwAMOTPFOJIZZt-yfKIQ-1; Mon, 14 Jul 2025 09:45:03 -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-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 2209119560B2 for ; Mon, 14 Jul 2025 13:45:02 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.45.242.6]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id A38A11800285 for ; Mon, 14 Jul 2025 13:45:01 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id BE13521E6925; Mon, 14 Jul 2025 15:44:58 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1752500704; 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=3c4K7n3IfwGoNKL5/wNBn8NnRX7qMr6IpHiyT/o7x2k=; b=cBXgOhJxutOK/qGT9MoCpyXKpFqFaOMvZLqEozogL6gKcvAKw/KiDBmNdh0CZfBfhG7RT1 aowiENHHkETvQsTx16KyVT2xY4vSM04a6aWIBLB1zFuXIWImBH/B723fVPjBO3IKcK+Iry a+v4MsMosesTXsxJ/pfJqVnZsysxuU0= X-MC-Unique: I0GwAMOTPFOJIZZt-yfKIQ-1 X-Mimecast-MFC-AGG-ID: I0GwAMOTPFOJIZZt-yfKIQ_1752500702 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: stefanha@redhat.com, John Snow Subject: [PULL 02/32] docs/sphinx: parse @references in freeform text Date: Mon, 14 Jul 2025 15:44:28 +0200 Message-ID: <20250714134458.2991097-3-armbru@redhat.com> In-Reply-To: <20250714134458.2991097-1-armbru@redhat.com> References: <20250714134458.2991097-1-armbru@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=lists.gnu.org; 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: -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_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1752505999679116600 Content-Type: text/plain; charset="utf-8" From: John Snow Oversight in the new qapidoc transmogrifier: @references in freeform documentation blocks were not being transformed to literals. This fixes that, and the next patch ensures that we're testing for this O:-) Signed-off-by: John Snow Message-ID: <20250618165353.1980365-3-jsnow@redhat.com> Acked-by: Markus Armbruster Signed-off-by: Markus Armbruster --- docs/sphinx/qapidoc.py | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index 5374dee8fa..adc14ade45 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -218,6 +218,11 @@ def generate_field( typ =3D self.format_type(member) self.add_field(kind, member.name, body, info, typ) =20 + @staticmethod + def reformat_arobase(text: str) -> str: + """ reformats @var to ``var`` """ + return re.sub(r"@([\w-]+)", r"``\1``", text) + # Transmogrification helpers =20 def visit_paragraph(self, section: QAPIDoc.Section) -> None: @@ -361,8 +366,7 @@ def visit_sections(self, ent: QAPISchemaDefinition) -> = None: =20 # Add sections in source order: for i, section in enumerate(sections): - # @var is translated to ``var``: - section.text =3D re.sub(r"@([\w-]+)", r"``\1``", section.text) + section.text =3D self.reformat_arobase(section.text) =20 if section.kind =3D=3D QAPIDoc.Kind.PLAIN: self.visit_paragraph(section) @@ -405,7 +409,7 @@ def visit_freeform(self, doc: QAPIDoc) -> None: =20 assert len(doc.all_sections) =3D=3D 1, doc.all_sections body =3D doc.all_sections[0] - text =3D body.text + text =3D self.reformat_arobase(body.text) info =3D doc.info =20 if re.match(r"=3D+ ", text): --=20 2.49.0