From nobody Sat Nov 15 12:17:38 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=quarantine dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1752505726; cv=none; d=zohomail.com; s=zohoarc; b=eHdcW2Lschvs6e9hgWOTGvVySslDuuOf/GoYbTkgHtjtThVC6nhCEpYoVkVGMruxoLweZsjQkztE+MOaaP3OeC+g+wJ8ABR4MMrqBx3BeKU+WkXF06jK5ik0pkygPfF3C/1xzku5RHEwIOM3kYp2eKCNOlH7n+waGsUCMKzrWoc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1752505726; 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=R1qX+mpYmZpUc+5wPTF7mRZVR+Q4ffPDdQeCnNltIEk=; b=lRZqT7ywG7DoMadzzuBHKaPOYroPdZvikQreq0WODl9JQo4WtZ5IMBoD72nE79vP61hNgi84ryiZNmwLULdFuAt+qiePfkzm3G8DXyN58XLY5z2aBuKLfkCNkIRtJkqpJt7xiv3sUsa7dRf0lpySSfJGiW4uZR5Mz7sj1Yvn184= 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=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1752505726722296.0346635236589; Mon, 14 Jul 2025 08:08:46 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ubKmz-0006B4-2C; Mon, 14 Jul 2025 11:08:30 -0400 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 1ubJUl-0000NP-RB for qemu-devel@nongnu.org; Mon, 14 Jul 2025 09:45:28 -0400 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 1ubJUW-0003d2-Sw for qemu-devel@nongnu.org; Mon, 14 Jul 2025 09:45:26 -0400 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-627-NWIY2ZLHPPmOCjfrFPd27Q-1; Mon, 14 Jul 2025 09:45:09 -0400 Received: from mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.111]) (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 935CF195605C for ; Mon, 14 Jul 2025 13:45:08 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.45.242.6]) by mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 478671803AF2 for ; Mon, 14 Jul 2025 13:45:08 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 1A4C421E65CE; Mon, 14 Jul 2025 15:44:59 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1752500711; 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=R1qX+mpYmZpUc+5wPTF7mRZVR+Q4ffPDdQeCnNltIEk=; b=Db+OmPdyJHHp5fmvGHZKgylPunMUi+icMLHlkDB6vsziCoyBtlre2h3VqimqwFzKGAyvgM m7L6J6uf88GhdzOVR+0LWGGR5FDXxJ6xOk7U36WmKFawCrYYzFSa5OJtkuJdostlMI0wwy g5La894PgvzVLrykT0pHvpnFu9KsBnU= X-MC-Unique: NWIY2ZLHPPmOCjfrFPd27Q-1 X-Mimecast-MFC-AGG-ID: NWIY2ZLHPPmOCjfrFPd27Q_1752500708 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: stefanha@redhat.com, John Snow Subject: [PULL 22/32] qapi: add cross-references to QOM Date: Mon, 14 Jul 2025 15:44:48 +0200 Message-ID: <20250714134458.2991097-23-armbru@redhat.com> In-Reply-To: <20250714134458.2991097-1-armbru@redhat.com> References: <20250714134458.2991097-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.111 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=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, 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_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_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: 1752505727925116600 Content-Type: text/plain; charset="utf-8" From: John Snow Signed-off-by: John Snow Message-ID: <20250711054005.60969-12-jsnow@redhat.com> Reviewed-by: Markus Armbruster Signed-off-by: Markus Armbruster --- qapi/qdev.json | 4 ++-- qapi/qom.json | 13 +++++++------ 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/qapi/qdev.json b/qapi/qdev.json index 6441357e00..e14a0c9259 100644 --- a/qapi/qdev.json +++ b/qapi/qdev.json @@ -97,10 +97,10 @@ # from the guest. Hot removal is an operation that requires guest # cooperation. This command merely requests that the guest begin # the hot removal process. Completion of the device removal -# process is signaled with a DEVICE_DELETED event. Guest reset +# process is signaled with a `DEVICE_DELETED` event. Guest reset # will automatically complete removal for all devices. If a # guest-side error in the hot removal process is detected, the -# device will not be removed and a DEVICE_UNPLUG_GUEST_ERROR event +# device will not be removed and a `DEVICE_UNPLUG_GUEST_ERROR` event # is sent. Some errors cannot be detected. # # Since: 0.14 diff --git a/qapi/qom.json b/qapi/qom.json index aa09eddbf9..4e85baae47 100644 --- a/qapi/qom.json +++ b/qapi/qom.json @@ -52,7 +52,7 @@ # # List properties of a object given a path in the object model. # -# @path: the path within the object model. See @qom-get for a +# @path: the path within the object model. See `qom-get` for a # description of this parameter. # # Returns: a list that describe the properties of the object. @@ -129,12 +129,12 @@ # # Set a property value. # -# @path: see @qom-get for a description of this parameter +# @path: see `qom-get` for a description of this parameter # # @property: the property name to set # # @value: a value who's type is appropriate for the property type. -# See @qom-get for a description of type mapping. +# See `qom-get` for a description of type mapping. # # Since: 1.2 # @@ -153,7 +153,7 @@ ## # @ObjectTypeInfo: # -# This structure describes a search result from @qom-list-types +# This structure describes a search result from `qom-list-types` # # @name: the type name found in the search # @@ -193,6 +193,7 @@ # # @typename: the type name of an object # +# # .. note:: Objects can create properties at runtime, for example to # describe links between different devices and/or objects. These # properties are not included in the output of this command. @@ -787,7 +788,7 @@ # # Properties for x-remote-object objects. # -# @fd: file descriptor name previously passed via 'getfd' command +# @fd: file descriptor name previously passed via `getfd` command # # @devid: the id of the device to be associated with the file # descriptor @@ -816,7 +817,7 @@ # # Properties for iommufd objects. # -# @fd: file descriptor name previously passed via 'getfd' command, +# @fd: file descriptor name previously passed via `getfd` command, # which represents a pre-opened /dev/iommu. This allows the # iommufd object to be shared across several subsystems (VFIO, # VDPA, ...), and the file descriptor to be shared with other --=20 2.49.0