From nobody Tue Jan 28 23:58:48 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=1734052776; cv=none; d=zohomail.com; s=zohoarc; b=iyUyEEGRZPIMWGbY4ZyWS6wullFAmSQbjlbInKIAdeCqavNQXE5Lbc2U+b/ScRcpP49XGT0R2cC7hIf4oPllVz2NGSMkWx47SntSVr7hVxVA98YI8+2aCQHKmSlEJ1JdQCwcBN5chlRubvPhtbUpBFzPt6Gk6abWahS0aUGNOo4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1734052776; 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=+UQTiLGXqIWSEzCIAZ1iFQL8e/U6Oks1NAbc4rk+beo=; b=agCqZm44aILovtMKRgV5uHHXbO85IkLFoO2mhtxSklFlIJfs4sMEnbdjOmeSdmw54NLcLppSuwpO//42HcVpMPG41jrRuWPBhxfG5kdUzuhCVM7HELm8/ImTCsDpzEIOg9Y03y370nm6aU5e2wX2BTtSUt/VjFfN7JGFf9yH6oM= 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 1734052776772443.8550970223322; Thu, 12 Dec 2024 17:19:36 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tLuGD-0005uC-OV; Thu, 12 Dec 2024 20:14:29 -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 1tLuG9-0005tT-Ee for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:14:25 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tLuG3-0000eG-4j for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:14:25 -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-287-c9Gca_zZMzewS6Cn_i3rnQ-1; Thu, 12 Dec 2024 20:14:11 -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 F31A11955F42; Fri, 13 Dec 2024 01:14:10 +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 2BFE91956086; Fri, 13 Dec 2024 01:14:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1734052457; 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=+UQTiLGXqIWSEzCIAZ1iFQL8e/U6Oks1NAbc4rk+beo=; b=EIvLESF1B9G5H/0CM/2GSYR0AeiBdBbwmjATDL7rhbRuG/iCYtwMdI6tpxRjKMSaUutN/z i0PO6agq9EQLS52m7ekZ0bZ7n1QYDgmxSdR1oTKC4QqMgJBOiOyo6lxWlb5CPWvrnVDR2+ KKikBYnC5ZPQUyXgi+Sjgv2oaGhL4SQ= X-MC-Unique: c9Gca_zZMzewS6Cn_i3rnQ-1 X-Mimecast-MFC-AGG-ID: c9Gca_zZMzewS6Cn_i3rnQ 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 Subject: [RFC PATCH v2 14/35] docs/qapi-domain: add "Features:" field lists Date: Thu, 12 Dec 2024 20:12:43 -0500 Message-ID: <20241213011307.2942030-15-jsnow@redhat.com> In-Reply-To: <20241213011307.2942030-1-jsnow@redhat.com> References: <20241213011307.2942030-1-jsnow@redhat.com> MIME-Version: 1.0 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.129.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_MSPIKE_H2=-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: 1734052778342116600 Content-Type: text/plain; charset="utf-8" Add support for Features field lists. There is no QAPI-specific functionality here, but this could be changed if desired (if we wanted the feature names to link somewhere, for instance.) This feature list doesn't have any restrictions, so it can be used to document object-wide features or per-member features as deemed appropriate. It's essentially free-form text. Signed-off-by: John Snow --- docs/sphinx/qapi-domain.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/qapi-domain.py b/docs/sphinx/qapi-domain.py index 15a615d8adb..9b83262a0c6 100644 --- a/docs/sphinx/qapi-domain.py +++ b/docs/sphinx/qapi-domain.py @@ -34,7 +34,7 @@ from sphinx.locale import _, __ from sphinx.roles import XRefRole from sphinx.util import logging -from sphinx.util.docfields import TypedField +from sphinx.util.docfields import GroupedField, TypedField from sphinx.util.docutils import SphinxDirective from sphinx.util.nodes import make_id, make_refnode =20 @@ -122,6 +122,16 @@ class QAPIObject(ObjectDescription[Signature]): } ) =20 + doc_field_types =3D [ + # :feat name: descr + GroupedField( + "feature", + label=3D_("Features"), + names=3D("feat",), + can_collapse=3DFalse, + ), + ] + def get_signature_prefix(self, sig: str) -> List[nodes.Node]: """Returns a prefix to put before the object name in the signature= .""" assert self.objtype --=20 2.47.0