From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Markus Armbruster" <armbru@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@linaro.org>,
"Michael Roth" <michael.roth@amd.com>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Eric Blake" <eblake@redhat.com>,
"Thomas Huth" <thuth@redhat.com>,
"Alex Bennée" <alex.bennee@linaro.org>,
"Peter Maydell" <peter.maydell@linaro.org>,
"John Snow" <jsnow@redhat.com>,
"Harmonie Snow" <harmonie@gmail.com>
Subject: [PATCH v2 24/62] docs/qapi-domain: add :unstable: directive option
Date: Sun, 9 Mar 2025 04:35:11 -0400 [thread overview]
Message-ID: <20250309083550.5155-25-jsnow@redhat.com> (raw)
In-Reply-To: <20250309083550.5155-1-jsnow@redhat.com>
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 <harmonie@gmail.com>
Signed-off-by: John Snow <jsnow@redhat.com>
---
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/theme_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^="highlight"] pre {
margin: 0.25em;
}
-.qapi-deprecated {
+.qapi-deprecated,.qapi-unstable {
background-color: #fffef5;
border: solid #fff176 6px;
font-weight: bold;
@@ -230,6 +230,10 @@ div[class^="highlight"] pre {
margin: 5px;
}
+.qapi-unstable::before {
+ content: '🚧 ';
+}
+
.qapi-deprecated::before {
content: '⚠️ ';
}
diff --git a/docs/sphinx/qapi_domain.py b/docs/sphinx/qapi_domain.py
index 482f4bcde3b..4fc9608e170 100644
--- a/docs/sphinx/qapi_domain.py
+++ b/docs/sphinx/qapi_domain.py
@@ -182,6 +182,7 @@ class QAPIObject(QAPIDescription):
# These are QAPI originals:
"since": directives.unchanged,
"deprecated": directives.flag,
+ "unstable": directives.flag,
}
)
@@ -277,6 +278,13 @@ def _add_pip(source: str, content: str, classname: str) -> None:
"qapi-deprecated",
)
+ if "unstable" in self.options:
+ _add_pip(
+ ":unstable:",
+ f"This {self.objtype} is unstable/experimental.",
+ "qapi-unstable",
+ )
+
if infopips.children:
contentnode.insert(0, infopips)
--
2.48.1
next prev parent reply other threads:[~2025-03-09 8:41 UTC|newest]
Thread overview: 100+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-09 8:34 [PATCH v2 00/62] docs: Add new QAPI transmogrifier John Snow
2025-03-09 8:34 ` [PATCH v2 01/62] do-not-merge John Snow
2025-03-09 8:34 ` [PATCH v2 02/62] qapi: shush pylint up John Snow
2025-03-09 19:41 ` Markus Armbruster
2025-03-09 8:34 ` [PATCH v2 03/62] docs/sphinx: create QAPI domain extension stub John Snow
2025-03-09 8:34 ` [PATCH v2 04/62] docs/sphinx: add compat.py module and nested_parse helper John Snow
2025-03-09 8:34 ` [PATCH v2 05/62] docs/qapi-domain: add QAPI domain object registry John Snow
2025-03-09 8:34 ` [PATCH v2 06/62] docs/qapi-domain: add QAPI index John Snow
2025-03-09 8:34 ` [PATCH v2 07/62] docs/qapi-domain: add resolve_any_xref() John Snow
2025-03-09 8:34 ` [PATCH v2 08/62] docs/qapi-domain: add QAPI xref roles John Snow
2025-03-09 8:34 ` [PATCH v2 09/62] docs/qapi-domain: add compatibility node classes John Snow
2025-03-09 8:34 ` [PATCH v2 10/62] docs/qapi-domain: Add ObjectDescription abstract class John Snow
2025-03-10 9:15 ` Markus Armbruster
2025-03-10 21:12 ` John Snow
2025-03-09 8:34 ` [PATCH v2 11/62] docs/qapi-domain: add qapi:module directive John Snow
2025-03-10 9:47 ` Markus Armbruster
2025-03-09 8:34 ` [PATCH v2 12/62] docs/qapi-domain: add QAPIObject class John Snow
2025-03-10 9:46 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 13/62] docs/qapi-domain: add qapi:command directive John Snow
2025-03-09 8:35 ` [PATCH v2 14/62] docs/qapi-domain: add :since: directive option John Snow
2025-03-09 8:35 ` [PATCH v2 15/62] docs/qapi-domain: add "Arguments:" field lists John Snow
2025-03-09 20:37 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 16/62] docs/qapi-domain: add "Features:" " John Snow
2025-03-09 20:42 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 17/62] docs/qapi-domain: add "Errors:" " John Snow
2025-03-09 8:35 ` [PATCH v2 18/62] docs/qapi-domain: add "Return:" " John Snow
2025-03-09 20:46 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 19/62] docs/qapi-domain: add qapi:enum directive John Snow
2025-03-09 8:35 ` [PATCH v2 20/62] docs/qapi-domain: add qapi:alternate directive John Snow
2025-03-09 8:35 ` [PATCH v2 21/62] docs/qapi-domain: add qapi:event directive John Snow
2025-03-09 8:35 ` [PATCH v2 22/62] docs/qapi-domain: add qapi:object directive John Snow
2025-03-09 8:35 ` [PATCH v2 23/62] docs/qapi-domain: add :deprecated: directive option John Snow
2025-03-09 20:51 ` Markus Armbruster
2025-03-09 8:35 ` John Snow [this message]
2025-03-10 9:54 ` [PATCH v2 24/62] docs/qapi-domain: add :unstable: " Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 25/62] docs/qapi-domain: add :ifcond: " John Snow
2025-03-09 8:35 ` [PATCH v2 26/62] docs/qapi-domain: add warnings for malformed field lists John Snow
2025-03-09 8:35 ` [PATCH v2 27/62] docs/qapi-domain: add type cross-refs to " John Snow
2025-03-09 8:35 ` [PATCH v2 28/62] docs/qapi-domain: add CSS styling John Snow
2025-03-10 9:47 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 29/62] docs/qapi-domain: add XREF compatibility goop for Sphinx < 4.1 John Snow
2025-03-09 8:35 ` [PATCH v2 30/62] docs/qapi-domain: warn when QAPI domain xrefs fail to resolve John Snow
2025-03-09 8:35 ` [PATCH v2 31/62] docs/qapi-domain: Fix error context reporting in Sphinx 5.x and 6.x John Snow
2025-03-09 8:35 ` [PATCH v2 32/62] qapi/parser: adjust info location for doc body section John Snow
2025-03-09 20:53 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 33/62] qapi: expand tags to all doc sections John Snow
2025-03-09 20:57 ` Markus Armbruster
2025-03-10 11:44 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 34/62] qapi/schema: add __repr__ to QAPIDoc.Section John Snow
2025-03-09 8:35 ` [PATCH v2 35/62] docs/qapidoc: add transmogrifier stub John Snow
2025-03-09 8:35 ` [PATCH v2 36/62] docs/qapidoc: split old implementation into qapidoc_legacy.py John Snow
2025-03-09 8:35 ` [PATCH v2 37/62] docs/qapidoc: Fix static typing on qapidoc.py John Snow
2025-03-09 8:35 ` [PATCH v2 38/62] do-not-merge John Snow
2025-03-09 8:35 ` [PATCH v2 39/62] docs/qapidoc: add transmogrifier class stub John Snow
2025-03-09 8:35 ` [PATCH v2 40/62] docs/qapidoc: add visit_module() method John Snow
2025-03-09 8:35 ` [PATCH v2 41/62] qapi/source: allow multi-line QAPISourceInfo advancing John Snow
2025-03-09 20:59 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 42/62] docs/qapidoc: add visit_freeform() method John Snow
2025-03-09 21:01 ` Markus Armbruster
2025-03-10 21:11 ` John Snow
2025-03-09 8:35 ` [PATCH v2 43/62] docs/qapidoc: add preamble() method John Snow
2025-03-09 21:03 ` Markus Armbruster
2025-03-10 21:05 ` John Snow
2025-03-10 21:06 ` John Snow
2025-03-10 9:46 ` Markus Armbruster
2025-03-10 11:24 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 44/62] docs/qapidoc: add visit_paragraph() method John Snow
2025-03-09 8:35 ` [PATCH v2 45/62] docs/qapidoc: add visit_errors() method John Snow
2025-03-09 21:05 ` Markus Armbruster
2025-03-10 21:17 ` John Snow
2025-03-11 6:08 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 46/62] docs/qapidoc: add format_type() method John Snow
2025-03-09 8:35 ` [PATCH v2 47/62] docs/qapidoc: add add_field() and generate_field() helper methods John Snow
2025-03-09 8:35 ` [PATCH v2 48/62] docs/qapidoc: add visit_feature() method John Snow
2025-03-09 21:06 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 49/62] docs/qapidoc: prepare to record entity being transmogrified John Snow
2025-03-09 8:35 ` [PATCH v2 50/62] docs/qapidoc: add visit_returns() method John Snow
2025-03-09 21:08 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 51/62] docs/qapidoc: add visit_member() method John Snow
2025-03-09 21:09 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 52/62] docs/qapidoc: add visit_sections() method John Snow
2025-03-09 21:10 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 53/62] docs/qapidoc: add visit_entity() John Snow
2025-03-09 8:35 ` [PATCH v2 54/62] docs/qapidoc: implement transmogrify() method John Snow
2025-03-10 12:42 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 55/62] docs/qapidoc: process @foo into ``foo`` John Snow
2025-03-09 8:35 ` [PATCH v2 56/62] docs/qapidoc: add intermediate output debugger John Snow
2025-03-09 21:17 ` Markus Armbruster
2025-03-10 21:26 ` John Snow
2025-03-09 8:35 ` [PATCH v2 57/62] docs/qapidoc: Add "the members of" pointers John Snow
2025-03-09 8:35 ` [PATCH v2 58/62] docs/qapidoc: generate entries for undocumented members John Snow
2025-03-10 10:08 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 59/62] qapi/parser: add undocumented stub members to all_sections John Snow
2025-03-10 10:19 ` Markus Armbruster
2025-03-09 8:35 ` [PATCH v2 60/62] docs: disambiguate cross-references John Snow
2025-03-09 8:35 ` [PATCH v2 61/62] docs: enable qapidoc transmogrifier for QEMU QMP Reference John Snow
2025-03-09 21:13 ` Markus Armbruster
2025-03-10 21:33 ` John Snow
2025-03-09 8:35 ` [PATCH v2 62/62] docs: add qapi-domain syntax documentation John Snow
2025-03-09 21:19 ` [PATCH v2 00/62] docs: Add new QAPI transmogrifier Markus Armbruster
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250309083550.5155-25-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=eblake@redhat.com \
--cc=harmonie@gmail.com \
--cc=michael.roth@amd.com \
--cc=peter.maydell@linaro.org \
--cc=philmd@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=thuth@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).