From nobody Mon Apr 7 17:14:59 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=1741697017; cv=none;
d=zohomail.com; s=zohoarc;
b=K6qfRoMtp/pFYHJXkWLSA8uVJEKWIN1uRS5QSik2riTyVG1PEytbWlL7xuPflI/79KnXUydAlJQghlPydj4GeWAM13W7XLZxlkfsw0cRiGNUDriQYawW8TU5022dd0uslLuchTpPckhkAN6lUdx1ICmPwXmv8YZM0x5G1XSRJWk=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com;
s=zohoarc;
t=1741697017;
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=dqpBYp4PbrmJ7vPfHHWBAjHCBdNfG66HXq5ykYSxADY=;
b=hzlFl3Uw4h+JcyVRboi3jaOQX6/Sk2i3j0kN/WQMtI/4azwMvCTOeODb4JvHl3UBd7kU6fBqisSbOKXcG+yq4LCBG7gnowJ4GlplNDwKTBUICffpKg7IoVybiTnfjy3UI0E1tcyfoZCT9/Wxq3e6SX/ZxK78AaAf1TjiibPNSUM=
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=<armbru@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 1741697017210877.285975944832;
Tue, 11 Mar 2025 05:43:37 -0700 (PDT)
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 1trxqX-0003E3-J3; Tue, 11 Mar 2025 07:32:30 -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 <armbru@redhat.com>) id 1trxq9-00034y-Sj
for qemu-devel@nongnu.org; Tue, 11 Mar 2025 07:32:07 -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 <armbru@redhat.com>) id 1trxpz-0006Sp-6F
for qemu-devel@nongnu.org; Tue, 11 Mar 2025 07:32:03 -0400
Received: from mx-prod-mc-08.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-116-qrZ1C4tSMYSdgYDcaBdRvQ-1; Tue,
11 Mar 2025 07:31:49 -0400
Received: from mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com
(mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.111])
(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-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS
id C789D1801A12
for <qemu-devel@nongnu.org>; Tue, 11 Mar 2025 11:31:48 +0000 (UTC)
Received: from blackfin.pond.sub.org (unknown [10.22.74.4])
by mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with
ESMTPS
id 0F4231800268
for <qemu-devel@nongnu.org>; Tue, 11 Mar 2025 11:31:48 +0000 (UTC)
Received: by blackfin.pond.sub.org (Postfix, from userid 1000)
id C579321E66A7; Tue, 11 Mar 2025 12:31:37 +0100 (CET)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;
s=mimecast20190719; t=1741692711;
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=dqpBYp4PbrmJ7vPfHHWBAjHCBdNfG66HXq5ykYSxADY=;
b=ZQS4E5r3tZi4Ew5hRMy/skPhveKPVY2DJ42sHJOFAUT8yC1ODgEo7Ia0fps6/BIYToQAnw
4Tx4rpD/6lVbmq/Ns/l0ucAUdiYmXKW5gt4JlOIT5ttGhqspTa1F4Rvrr+oCbPJxRPkBAQ
98FJX4rD/PpHsjNrf1blbfAqGkTdP4c=
X-MC-Unique: qrZ1C4tSMYSdgYDcaBdRvQ-1
X-Mimecast-MFC-AGG-ID: qrZ1C4tSMYSdgYDcaBdRvQ_1741692708
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: stefanha@redhat.com,
John Snow <jsnow@redhat.com>
Subject: [PULL 05/61] docs/qapi-domain: add resolve_any_xref()
Date: Tue, 11 Mar 2025 12:30:41 +0100
Message-ID: <20250311113137.1277125-6-armbru@redhat.com>
In-Reply-To: <20250311113137.1277125-1-armbru@redhat.com>
References: <20250311113137.1277125-1-armbru@redhat.com>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.111
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_H2=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: <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: 1741697019195019000
Content-Type: text/plain; charset="utf-8"
From: John Snow <jsnow@redhat.com>
Add the ability to resolve cross-references using the `any`
cross-reference syntax. Adding QAPI-specific cross-reference roles will
be added in a forthcoming commit, and will share the same find_obj()
helper.
(There's less code needed for the generic cross-reference resolver, so
it comes first in this series.)
Once again, this code is based very heavily on sphinx.domains.python.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250311034303.75779-8-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
docs/sphinx/qapi_domain.py | 96 ++++++++++++++++++++++++++++++++++++--
1 file changed, 93 insertions(+), 3 deletions(-)
diff --git a/docs/sphinx/qapi_domain.py b/docs/sphinx/qapi_domain.py
index 3e7718d32d..f05c2cadf0 100644
--- a/docs/sphinx/qapi_domain.py
+++ b/docs/sphinx/qapi_domain.py
@@ -16,6 +16,9 @@
Tuple,
)
=20
+from docutils import nodes
+
+from sphinx.addnodes import pending_xref
from sphinx.domains import (
Domain,
Index,
@@ -24,10 +27,15 @@
)
from sphinx.locale import _, __
from sphinx.util import logging
+from sphinx.util.nodes import make_refnode
=20
=20
if TYPE_CHECKING:
+ from docutils.nodes import Element
+
from sphinx.application import Sphinx
+ from sphinx.builders import Builder
+ from sphinx.environment import BuildEnvironment
=20
logger =3D logging.getLogger(__name__)
=20
@@ -179,9 +187,91 @@ def merge_domaindata(
)
self.objects[fullname] =3D obj
=20
- def resolve_any_xref(self, *args: Any, **kwargs: Any) -> Any:
- # pylint: disable=3Dunused-argument
- return []
+ def find_obj(
+ self, modname: str, name: str, typ: Optional[str]
+ ) -> list[tuple[str, ObjectEntry]]:
+ """
+ Find a QAPI object for "name", perhaps using the given module.
+
+ Returns a list of (name, object entry) tuples.
+
+ :param modname: The current module context (if any!)
+ under which we are searching.
+ :param name: The name of the x-ref to resolve;
+ may or may not include a leading module.
+ :param type: The role name of the x-ref we're resolving, if provid=
ed.
+ (This is absent for "any" lookups.)
+ """
+ if not name:
+ return []
+
+ names: list[str] =3D []
+ matches: list[tuple[str, ObjectEntry]] =3D []
+
+ fullname =3D name
+ if "." in fullname:
+ # We're searching for a fully qualified reference;
+ # ignore the contextual module.
+ pass
+ elif modname:
+ # We're searching for something from somewhere;
+ # try searching the current module first.
+ # e.g. :qapi:cmd:`query-block` or `query-block` is being searc=
hed.
+ fullname =3D f"{modname}.{name}"
+
+ if typ is None:
+ # type isn't specified, this is a generic xref.
+ # search *all* qapi-specific object types.
+ objtypes: List[str] =3D list(self.object_types)
+ else:
+ # type is specified and will be a role (e.g. obj, mod, cmd)
+ # convert this to eligible object types (e.g. command, module)
+ # using the QAPIDomain.object_types table.
+ objtypes =3D self.objtypes_for_role(typ, [])
+
+ if name in self.objects and self.objects[name].objtype in objtypes:
+ names =3D [name]
+ elif (
+ fullname in self.objects
+ and self.objects[fullname].objtype in objtypes
+ ):
+ names =3D [fullname]
+ else:
+ # exact match wasn't found; e.g. we are searching for
+ # `query-block` from a different (or no) module.
+ searchname =3D "." + name
+ names =3D [
+ oname
+ for oname in self.objects
+ if oname.endswith(searchname)
+ and self.objects[oname].objtype in objtypes
+ ]
+
+ matches =3D [(oname, self.objects[oname]) for oname in names]
+ if len(matches) > 1:
+ matches =3D [m for m in matches if not m[1].aliased]
+ return matches
+
+ def resolve_any_xref(
+ self,
+ env: BuildEnvironment,
+ fromdocname: str,
+ builder: Builder,
+ target: str,
+ node: pending_xref,
+ contnode: Element,
+ ) -> List[Tuple[str, nodes.reference]]:
+ results: List[Tuple[str, nodes.reference]] =3D []
+ matches =3D self.find_obj(node.get("qapi:module"), target, None)
+ for name, obj in matches:
+ rolename =3D self.role_for_objtype(obj.objtype)
+ assert rolename is not None
+ role =3D f"qapi:{rolename}"
+ refnode =3D make_refnode(
+ builder, fromdocname, obj.docname, obj.node_id, contnode, =
name
+ )
+ results.append((role, refnode))
+ return results
=20
=20
def setup(app: Sphinx) -> Dict[str, Any]:
--=20
2.48.1