From nobody Fri Apr 4 21:16:10 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=1741947123; cv=none; d=zohomail.com; s=zohoarc; b=YN296HnmJAqEOLki1a1fW4I/Dqj3pmXFtYceox36DhXL7V+TVE6ai3eXtNaQ1mLGmgwKZDPxJnDrxBS1Q8iNEF07gERbhc7ybB+obotdj7WHGmtLl4YX4m06wm4lqrevpMqBr5tZvhPn98Ow7mDvswxSXTzqLgQKIFvDnKhR08c= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1741947123; 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=L6K58Cl2kQo8RwkeszDmBOm0EdqS+sV+IffyEcy9VvA=; b=WTDFxzld5zYKuvW7jOByGjWF5vuqqeEHyBMr58CGd9eWsmTSd03X9oTpgxKpvz6j1BlOWrzZAfB2cDygF+q0kP65POpJHIsOP/mSyjLIvJZSykBjjIhTEu6q8EpCYyoZUAUms+oV0Znv1yYVII45P8Tqopof2RU08LrDxBiW/2E= 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 1741947123307427.2631548574369; Fri, 14 Mar 2025 03:12:03 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tt20E-0006Ie-Gz; Fri, 14 Mar 2025 06:10:55 -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 1tt20A-0006Hj-MZ for qemu-devel@nongnu.org; Fri, 14 Mar 2025 06:10:50 -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 1tt208-00021l-0U for qemu-devel@nongnu.org; Fri, 14 Mar 2025 06:10:50 -0400 Received: from mx-prod-mc-06.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-352-gRnyYzAQMcqJTk9iHuRRcw-1; Fri, 14 Mar 2025 06:10:45 -0400 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-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 4277C180025A for ; Fri, 14 Mar 2025 10:10:44 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.22.74.4]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id B236B1955BCB for ; Fri, 14 Mar 2025 10:10:43 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id C676F21E66A4; Fri, 14 Mar 2025 11:10:38 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1741947046; 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=L6K58Cl2kQo8RwkeszDmBOm0EdqS+sV+IffyEcy9VvA=; b=I80qXmiQOjO0zvkw7txnWNHwqJFv0rKqPNWmXKtPDU8w7tG9ErVd5/Rl+MudXyTlQY405j sp+tjnvYqh9Pw0Auqi4MWsT5YtjH+l6bGZJ78zTnK7Ygq4hbS/1mp3NmVBju/cpr5daRWq fPcAeb6FgI16iIgRYqw+fij9n1/yN7s= X-MC-Unique: gRnyYzAQMcqJTk9iHuRRcw-1 X-Mimecast-MFC-AGG-ID: gRnyYzAQMcqJTk9iHuRRcw_1741947044 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: stefanha@redhat.com, John Snow Subject: [PULL 04/12] docs/qapi_domain: add namespace support to FQN Date: Fri, 14 Mar 2025 11:10:30 +0100 Message-ID: <20250314101038.2408751-5-armbru@redhat.com> In-Reply-To: <20250314101038.2408751-1-armbru@redhat.com> References: <20250314101038.2408751-1-armbru@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=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: 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: 1741947123830019000 Content-Type: text/plain; charset="utf-8" From: John Snow This patch adds a namespace component to the "Fully Qualified Name", in the form of "domain:module.name". As there are no namespace directives or options yet, this component will simply be empty as of this patch. Signed-off-by: John Snow Message-ID: <20250313044312.189276-4-jsnow@redhat.com> Acked-by: Markus Armbruster Signed-off-by: Markus Armbruster --- docs/sphinx/qapi_domain.py | 35 +++++++++++++++++++++++++++-------- 1 file changed, 27 insertions(+), 8 deletions(-) diff --git a/docs/sphinx/qapi_domain.py b/docs/sphinx/qapi_domain.py index 6b23fc73ef..48a082d489 100644 --- a/docs/sphinx/qapi_domain.py +++ b/docs/sphinx/qapi_domain.py @@ -178,15 +178,18 @@ def get_index_text(self, name: Signature) -> Tuple[st= r, str]: # NB: this is used for the global index, not the QAPI index. return ("single", f"{name} (QMP {self.objtype})") =20 - def _get_context(self) -> str: + def _get_context(self) -> Tuple[str, str]: + namespace =3D self.options.get( + "namespace", self.env.ref_context.get("qapi:namespace", "") + ) modname =3D self.options.get( "module", self.env.ref_context.get("qapi:module", "") ) - assert isinstance(modname, str) - return modname + + return namespace, modname =20 def _get_fqn(self, name: Signature) -> str: - modname =3D self._get_context() + namespace, modname =3D self._get_context() =20 # If we're documenting a module, don't include the module as # part of the FQN; we ARE the module! @@ -195,6 +198,8 @@ def _get_fqn(self, name: Signature) -> str: =20 if modname: name =3D f"{modname}.{name}" + if namespace: + name =3D f"{namespace}:{name}" return name =20 def add_target_and_index( @@ -227,13 +232,18 @@ def add_target_and_index( ) =20 @staticmethod - def split_fqn(name: str) -> Tuple[str, str]: + def split_fqn(name: str) -> Tuple[str, str, str]: + if ":" in name: + ns, name =3D name.split(":") + else: + ns =3D "" + if "." in name: module, name =3D name.split(".") else: module =3D "" =20 - return (module, name) + return (ns, module, name) =20 def _object_hierarchy_parts( self, sig_node: desc_signature @@ -251,7 +261,7 @@ def _toc_entry_name(self, sig_node: desc_signature) -> = str: return "" =20 config =3D self.env.app.config - modname, name =3D toc_parts + namespace, modname, name =3D toc_parts =20 if config.toc_object_entries_show_parents =3D=3D "domain": ret =3D name @@ -259,6 +269,10 @@ def _toc_entry_name(self, sig_node: desc_signature) ->= str: "qapi:module", "" ): ret =3D f"{modname}.{name}" + if namespace and namespace !=3D self.env.ref_context.get( + "qapi:namespace", "" + ): + ret =3D f"{namespace}:{ret}" return ret if config.toc_object_entries_show_parents =3D=3D "hide": return name @@ -334,10 +348,15 @@ def handle_signature(self, sig: str, signode: desc_si= gnature) -> Signature: As such, the only argument here is "sig", which is just the QAPI definition name. """ - modname =3D self._get_context() + # No module or domain info allowed in the signature! + assert ":" not in sig + assert "." not in sig =20 + namespace, modname =3D self._get_context() signode["fullname"] =3D self._get_fqn(sig) + signode["namespace"] =3D namespace signode["module"] =3D modname + sig_prefix =3D self.get_signature_prefix() if sig_prefix: signode +=3D addnodes.desc_annotation( --=20 2.48.1