From nobody Thu Apr 3 10:00:41 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=1741664898; cv=none; d=zohomail.com; s=zohoarc; b=EaHtVcY+ue+0w3tvk/5zP+4tgMiH5gj32CNR1gHKI6cm5xq1WBgfQVhuZ1H2q8Ajz2VYuXVs9fgRoJjSYT+0zyLlctvgsJ21il0UmPUA13fyRFToYM70FJ0Ah3FA5E5cG5NzOEaWxZ9kLwQW7HRxq9w6d1SMr4b7dXhBxWIg028= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1741664898; 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=vdmIN+VT9IZHhi/TgTZYeuN0vGYUCp3sPhV4+H40+ks=; b=k814Txy6qkOH3u2LsNIoyEoEbanlRpiiecdOzy9aBkBGRWmKUTUKDDV2z3ZI2jkgMnR0VRzXHNiRLA7QZLt35FlbDL76ymWkcplw2sGSRImjrd02e5QPeswZwP1Ws1cpfwM80SIfvA0nVAk2ptiGzJSIygGvsouoTMmB4u4vJNQ= 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=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1741664898898349.35049973647585; Mon, 10 Mar 2025 20:48:18 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1trqaZ-0004Lm-60; Mon, 10 Mar 2025 23:47:31 -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 1trqZb-0000U3-SE for qemu-devel@nongnu.org; Mon, 10 Mar 2025 23:46:34 -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 1trqZV-0002oc-LV for qemu-devel@nongnu.org; Mon, 10 Mar 2025 23:46:26 -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-184-RcH9QxS5PyaKSsZ2qjh3Ww-1; Mon, 10 Mar 2025 23:46:18 -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 7205C19560AB; Tue, 11 Mar 2025 03:46:17 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.64.49]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id E31841800366; Tue, 11 Mar 2025 03:46:14 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1741664784; 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=vdmIN+VT9IZHhi/TgTZYeuN0vGYUCp3sPhV4+H40+ks=; b=ar+5jTR+4foavWlLfjbLq+KsV4hgQQGVsJP/tL+m/nlubumTyNyykxd1h2PJvElhvabFzP yJipO6OJj2hZdYhCw14w3hMg0UxIchYugTNd5Vuj2lMgEwOWIxiZLIei2xzQKj4UUTJ5dX YfjqkhWQz/UrhjdA2v2fgkVteyi4m8A= X-MC-Unique: RcH9QxS5PyaKSsZ2qjh3Ww-1 X-Mimecast-MFC-AGG-ID: RcH9QxS5PyaKSsZ2qjh3Ww_1741664777 From: John Snow To: qemu-devel@nongnu.org Cc: Peter Maydell , John Snow , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Eric Blake , Michael Roth , Thomas Huth , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , =?UTF-8?q?Alex=20Benn=C3=A9e?= , Markus Armbruster Subject: [PATCH v3 55/63] docs/qapidoc: process @foo into ``foo`` Date: Mon, 10 Mar 2025 23:42:53 -0400 Message-ID: <20250311034303.75779-56-jsnow@redhat.com> In-Reply-To: <20250311034303.75779-1-jsnow@redhat.com> References: <20250311034303.75779-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=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: -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, 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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1741664901661019100 Content-Type: text/plain; charset="utf-8" Add support for the special QAPI doc syntax to process @references as ``preformatted text``. At the moment, there are no actual cross-references for individual members, so there is nothing to link against. For now, process it identically to how we did in the old qapidoc system. Signed-off-by: John Snow --- docs/sphinx/qapidoc.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index 32baf66a390..f98f75cb2f8 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -303,6 +303,9 @@ def visit_sections(self, ent: QAPISchemaDefinition) -> = None: =20 # Add sections in source order: for section in sections: + # @var is translated to ``var``: + section.text =3D re.sub(r"@([\w-]+)", r"``\1``", section.text) + if section.kind =3D=3D QAPIDoc.Kind.PLAIN: self.visit_paragraph(section) elif section.kind =3D=3D QAPIDoc.Kind.MEMBER: --=20 2.48.1