From nobody Wed Jan 29 00:08:23 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=1734052516; cv=none; d=zohomail.com; s=zohoarc; b=MokWAjJeGpla/MMy+22zr7BuJihvJR23gW1cjVOkcWhRIGEk2jYvGejdBZvT2TkjnR8NJiAR2HFjopwEb6n1DXSm4vo6U6c/HFZaZKqF4e1zx8k6NcSL9wCKPzNxpjtm262AsE0D+ThdX/9zTh/jOvnVoQDh95h3uvPvKw0oJFo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1734052516; 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=k7AOJLSgaxPGr334OEFUTdnH0SfzGN2bBVrUU6r0Wqs=; b=A0gQnp0aQPUVa1hVnZQRGzsBkramejfeApTOkgAvvstQw4HVCRffFD/AZOU9ADSsxa+OlxfBNUYglqdvaExXFKYTB+Iai8vUJgdZ0q4AdRHYDkzrzhmJkC/0x+n1wCit6YdAbiTiSyK09qaPDlPtYkghB15tYtUueFVgC+2Z9pg= 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 1734052516035871.0559566525966; Thu, 12 Dec 2024 17:15:16 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tLuGj-0007fp-Po; Thu, 12 Dec 2024 20:15:02 -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 1tLuGg-0007SI-RJ for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:14:59 -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 1tLuGa-0000ho-UH for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:14:58 -0500 Received: from mx-prod-mc-02.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-164-E4vyYFvxN-i10cUNUp3n8w-1; Thu, 12 Dec 2024 20:14:47 -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-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id D5454195608A; Fri, 13 Dec 2024 01:14:46 +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 228C01956086; Fri, 13 Dec 2024 01:14:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1734052492; 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=k7AOJLSgaxPGr334OEFUTdnH0SfzGN2bBVrUU6r0Wqs=; b=Gm1sYUxZAdvZT7Qqw+sT3zkqWvlasd6cVAiOMNjLEjdELJ7uI1cK3h4qA17TPsKlmd9wyA bMu3OZMkpRC43a62ahrCWH+6Pt/uQ0L+wogtikJCMmsN5DNgkak7pYltUNHh6a/5QZIEjd e7Cu5s2SFIDS8pXvN7Qz9IQoWOJQ3OU= X-MC-Unique: E4vyYFvxN-i10cUNUp3n8w-1 X-Mimecast-MFC-AGG-ID: E4vyYFvxN-i10cUNUp3n8w 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 24/35] docs/qapi-domain: add :unstable: directive option Date: Thu, 12 Dec 2024 20:12:53 -0500 Message-ID: <20241213011307.2942030-25-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_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: 1734052516974116600 Although "unstable" is a feature (and *will* appear in the features list), add a special :unstable: option to generate an eye-catch that makes this information very hard to miss. (The intent is to modify qapidoc.py to add this option whenever it detects that the features list attached to a definition contains the "unstable" entry.) RFC: Same comments as last patch. Signed-off-by: Harmonie Snow Signed-off-by: John Snow --- docs/sphinx-static/theme_overrides.css | 6 +++++- docs/sphinx/qapi-domain.py | 8 ++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/sphinx-static/theme_overrides.css b/docs/sphinx-static/th= eme_overrides.css index 3765cab1b20..5f58f1d5246 100644 --- a/docs/sphinx-static/theme_overrides.css +++ b/docs/sphinx-static/theme_overrides.css @@ -221,7 +221,7 @@ div[class^=3D"highlight"] pre { margin: 0.25em; } =20 -.qapi-deprecated { +.qapi-deprecated,.qapi-unstable { background-color: #fffef5; border: solid #fff176 6px; font-weight: bold; @@ -230,6 +230,10 @@ div[class^=3D"highlight"] pre { margin: 5px; } =20 +.qapi-unstable::before { + content: '=F0=9F=9A=A7 '; +} + .qapi-deprecated::before { content: '=E2=9A=A0=EF=B8=8F '; } diff --git a/docs/sphinx/qapi-domain.py b/docs/sphinx/qapi-domain.py index b33d9927f4d..e522102ab7c 100644 --- a/docs/sphinx/qapi-domain.py +++ b/docs/sphinx/qapi-domain.py @@ -127,6 +127,7 @@ class QAPIObject(ObjectDescription[Signature]): # These are QAPI originals: "since": since_validator, "deprecated": directives.flag, + "unstable": directives.flag, } ) =20 @@ -256,6 +257,13 @@ def _add_pip(source: str, content: str, classname: str= ) -> None: "qapi-deprecated", ) =20 + if "unstable" in self.options: + _add_pip( + ":unstable:", + f"This {self.objtype} is unstable/experimental.", + "qapi-unstable", + ) + if infopips.children: contentnode.insert(0, infopips) =20 --=20 2.47.0