From nobody Tue Jan 28 23:55:35 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=1734052725; cv=none; d=zohomail.com; s=zohoarc; b=GVxKN8XYh6UWFLm7GzEagtRzwijnRtEksLLYYAXrjySxPgL/J06Mbd049CrS3C46t4XfVlXjL26FxNhMchTco6F5lw/tK5LDyqvZuKFKYvjRJqu+gYyGWfWL7rXkGYSyM3ksMVDRqhC0lA1SR8to1ZNKjLfcys7JGLIfIxkx6FI= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1734052725; h=Content-Type: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=BsM1OIJt181TdMGUiq9c24NHPTZFUCynBtcB5irAS+k=; b=Zw1fRQlsfju33hEontsdg3c2ZR8UUgVLGfj3IEId7WUxU0MsaKVj0pYUM6F63Ph0B+7tFX+ejMDxZ2EJbiClZOpzuUUbDPY4lVq6pjXQRzcGg4J0Y3GLMQ2Twe7mVRbllTplb+bTcYXjfr9d15lZXfIhTnpGgu7ApPYLGaCVH0M= 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 1734052725341533.0078885287662; Thu, 12 Dec 2024 17:18:45 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tLuGu-0008JL-7P; Thu, 12 Dec 2024 20:15:12 -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 ) id 1tLuGo-0007yh-KJ for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:15:08 -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 ) id 1tLuGf-0000hy-M3 for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:15:06 -0500 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-126-Eu7c0v-JNieCNvZcJNfpfA-1; Thu, 12 Dec 2024 20:14:51 -0500 Received: from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15]) (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 1375619560B7; Fri, 13 Dec 2024 01:14:50 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.88.22]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 25CFE1956086; Fri, 13 Dec 2024 01:14:46 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1734052495; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=BsM1OIJt181TdMGUiq9c24NHPTZFUCynBtcB5irAS+k=; b=hhg0TKnyeq3qL16Jyw0Bx3ULribhLKOnR3fPyy140jAFGR5caAGSCd/BeKGjvzYNJAJew4 qEIzW6famgTThmpFnV/nCMmINGfxnyKvkLJKY2hjzD28t+hShL3lsor/LF/EQ7vFy/KJjH 0wG8teZbh+MVukAlDU08WyQOD98UBLU= X-MC-Unique: Eu7c0v-JNieCNvZcJNfpfA-1 X-Mimecast-MFC-AGG-ID: Eu7c0v-JNieCNvZcJNfpfA From: John Snow To: qemu-devel@nongnu.org Cc: Michael Roth , Markus Armbruster , Peter Maydell , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Victor Toso de Carvalho , Paolo Bonzini , John Snow , Harmonie Snow Subject: [RFC PATCH v2 25/35] docs/qapi-domain: add :ifcond: directive option Date: Thu, 12 Dec 2024 20:12:54 -0500 Message-ID: <20241213011307.2942030-26-jsnow@redhat.com> In-Reply-To: <20241213011307.2942030-1-jsnow@redhat.com> References: <20241213011307.2942030-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 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: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.496, 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_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: 1734052726016116600 Add a special :ifcond: option that allows us to annotate the definition-level conditionals. RFC: This patch renders IFCOND information in two places, because I'm undecided about how to style this information. One option is in the signature bar, and another option is in an eye-catch, like :deprecated: or :unstable:. A benefit to having this be a directive option is that we can put it in the signature bar, the QAPI index, etc. However, if we merely want it in the content section, a directive would work just as well, e.g. ".. qapi:ifcond:: CONFIG_LINUX". (Though, having it be in the same containing box as the unstable/ifcond boxes might require some extra fiddling/post-processing to achieve. Generally, the less docutils tree muddling I have to do, the happier I am.) The syntax of the argument is currently undefined, but it is possible to parse it back down into constituent parts to avoid applying literal formatting to "AND" or "&&" or whichever syntax we formalize. (Or, in the future, applying cross-reference links to the config values for additional reading on some of those build options. Not for this series.) "Vote now on your phones!" Signed-off-by: Harmonie Snow Signed-off-by: John Snow --- docs/sphinx-static/theme_overrides.css | 13 +++++++++ docs/sphinx/qapi-domain.py | 39 ++++++++++++++++++++++++-- 2 files changed, 50 insertions(+), 2 deletions(-) diff --git a/docs/sphinx-static/theme_overrides.css b/docs/sphinx-static/th= eme_overrides.css index 5f58f1d5246..3fd326613d9 100644 --- a/docs/sphinx-static/theme_overrides.css +++ b/docs/sphinx-static/theme_overrides.css @@ -237,3 +237,16 @@ div[class^=3D"highlight"] pre { .qapi-deprecated::before { content: '=E2=9A=A0=EF=B8=8F '; } + +.qapi-ifcond::before { + /* gaze ye into the crystal ball to determine feature availability */ + content: '=F0=9F=94=AE '; +} + +.qapi-ifcond { + background-color: #f9f5ff; + border: solid #dac2ff 6px; + padding: 8px; + border-radius: 15px; + margin: 5px; +} diff --git a/docs/sphinx/qapi-domain.py b/docs/sphinx/qapi-domain.py index e522102ab7c..f7c7aaa507f 100644 --- a/docs/sphinx/qapi-domain.py +++ b/docs/sphinx/qapi-domain.py @@ -15,6 +15,7 @@ NamedTuple, Optional, Tuple, + Union, cast, ) =20 @@ -126,6 +127,7 @@ class QAPIObject(ObjectDescription[Signature]): "module": directives.unchanged, # Override contextual module = name # These are QAPI originals: "since": since_validator, + "ifcond": directives.unchanged, "deprecated": directives.flag, "unstable": directives.flag, } @@ -153,6 +155,22 @@ def get_signature_suffix(self, sig: str) -> List[nodes= .Node]: """Returns a suffix to put after the object name in the signature.= """ ret: List[nodes.Node] =3D [] =20 + if "ifcond" in self.options: + ret +=3D [ + space_node(" "), + nodes.inline( + self.options["ifcond"], + "", + nodes.Text("["), + nodes.literal("", "#if"), + space_node(" "), + nodes.literal( + self.options["ifcond"], self.options["ifcond"] + ), + nodes.Text("]"), + ), + ] + if "since" in self.options: ret +=3D [ space_node(" "), @@ -244,9 +262,14 @@ def _add_infopips(self, contentnode: addnodes.desc_con= tent) -> None: infopips =3D nodes.container() infopips.attributes["classes"].append("qapi-infopips") =20 - def _add_pip(source: str, content: str, classname: str) -> None: + def _add_pip( + source: str, content: Union[str, List[nodes.Node]], classname:= str + ) -> None: node =3D nodes.container(source) - node.append(nodes.Text(content)) + if isinstance(content, str): + node.append(nodes.Text(content)) + else: + node.extend(content) node.attributes["classes"].extend(["qapi-infopip", classname]) infopips.append(node) =20 @@ -264,6 +287,18 @@ def _add_pip(source: str, content: str, classname: str= ) -> None: "qapi-unstable", ) =20 + if self.options.get("ifcond", ""): + ifcond =3D self.options["ifcond"] + _add_pip( + f":ifcond: {ifcond}", + [ + nodes.emphasis("", "Availability"), + nodes.Text(": "), + nodes.literal(ifcond, ifcond), + ], + "qapi-ifcond", + ) + if infopips.children: contentnode.insert(0, infopips) =20 --=20 2.47.0