From nobody Wed Jan 29 00:16:00 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=1734052675; cv=none; d=zohomail.com; s=zohoarc; b=GYtCPMk+p5B3iZNenJL1ulP4+06LKpwJExP2mXob08SoZuFPB/1egAFLzt9nmfqfG2fPMHHTaKEBUZKtESfwzcKzHqnzH0wAXoJgovdhTtJTxDgwM4OjRg7KN2gLUjSq7ws5VRAlojsU09dzUF1Gd4sHmWz9K/2O0pmydfU5kFo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1734052675; 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=rBgNkaG4dv2YJJtgU9QuV3617bD/FTejS/XKs7tm4ow=; b=j3C1Sx71XY/WWzEk4EGwGJoiOFmVXJDgWEogeBsSa1D+Th4jkHjdpCxc2llxmtA5uitllIQEk2NYaWXFnlIH/2FJSSI4PgfdEOEoVTQ/M2DsN2hO6+k9KhHc+od11RmZ3o/iwmfFzCaJWPW0SbmAnxLL4EORO3lM+cZG8aC+z0I= 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 17340526757331000.0718867431539; Thu, 12 Dec 2024 17:17:55 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tLuI5-0002Lq-5c; Thu, 12 Dec 2024 20:16:26 -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 1tLuHY-0001TF-TH for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:15:57 -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 1tLuHS-0001BC-Jc for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:15:52 -0500 Received: from mx-prod-mc-05.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-124-EI1vaC3QNq-Cus2o4mtwTw-1; Thu, 12 Dec 2024 20:14:35 -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-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 8FA4B195609F; Fri, 13 Dec 2024 01:14:34 +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 0310F1956086; Fri, 13 Dec 2024 01:14:30 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1734052545; 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=rBgNkaG4dv2YJJtgU9QuV3617bD/FTejS/XKs7tm4ow=; b=iHw81wsGBfqxuWSWLfj7yiWXzJJoAqMw58lG0y+Exf/7V+9WLazAXQOo+I7+50y+s7HgDj UX95wpZ3s3Od/h+RgoUrsDVHNmcnF2qUaqADEMukPVXV1nyRPx5Xq91tpsQpTAEXDUT60r ciMrL/BLUGXoq1gkU89/1K1knReYIKU= X-MC-Unique: EI1vaC3QNq-Cus2o4mtwTw-1 X-Mimecast-MFC-AGG-ID: EI1vaC3QNq-Cus2o4mtwTw 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 21/35] docs/qapi-domain: add qapi:struct directive Date: Thu, 12 Dec 2024 20:12:50 -0500 Message-ID: <20241213011307.2942030-22-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_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: 1734052677690116600 Content-Type: text/plain; charset="utf-8" Adds the .. qapi:struct:: directive, object, and :qapi:struct:`name` cross-referencing role. As per usual, QAPI cross-referencing for types in the member field list will be added in a forthcoming commit. Signed-off-by: John Snow --- docs/sphinx/qapi-domain.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/sphinx/qapi-domain.py b/docs/sphinx/qapi-domain.py index e042421016f..d94d84bc186 100644 --- a/docs/sphinx/qapi-domain.py +++ b/docs/sphinx/qapi-domain.py @@ -344,6 +344,12 @@ class QAPIEvent(QAPIObjectWithMembers): pass =20 =20 +class QAPIStruct(QAPIObjectWithMembers): + """Description of a QAPI Struct.""" + + pass + + class QAPIModule(SphinxDirective): """ Directive to mark description of a new module. @@ -506,6 +512,7 @@ class QAPIDomain(Domain): "command": ObjType(_("command"), "cmd", "obj"), "event": ObjType(_("event"), "event", "obj"), "enum": ObjType(_("enum"), "enum", "obj", "type"), + "struct": ObjType(_("struct"), "struct", "obj", "type"), "alternate": ObjType(_("alternate"), "alt", "obj", "type"), } =20 @@ -516,6 +523,7 @@ class QAPIDomain(Domain): "command": QAPICommand, "event": QAPIEvent, "enum": QAPIEnum, + "struct": QAPIStruct, "alternate": QAPIAlternate, } =20 @@ -527,6 +535,7 @@ class QAPIDomain(Domain): "cmd": QAPIXRefRole(), "event": QAPIXRefRole(), "enum": QAPIXRefRole(), + "struct": QAPIXRefRole(), "alt": QAPIXRefRole(), # reference any data type (excludes modules, commands, events) "type": QAPIXRefRole(), --=20 2.47.0