qapi: add cross-references to QOM

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250711054005.60969-12-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
John Snow 2025-07-11 01:39:58 -04:00 committed by Markus Armbruster
parent b9abf7dd3f
commit 91581b49e1
2 changed files with 9 additions and 8 deletions

View File

@ -97,10 +97,10 @@
# from the guest. Hot removal is an operation that requires guest # from the guest. Hot removal is an operation that requires guest
# cooperation. This command merely requests that the guest begin # cooperation. This command merely requests that the guest begin
# the hot removal process. Completion of the device removal # 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 # will automatically complete removal for all devices. If a
# guest-side error in the hot removal process is detected, the # 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. # is sent. Some errors cannot be detected.
# #
# Since: 0.14 # Since: 0.14

View File

@ -52,7 +52,7 @@
# #
# List properties of a object given a path in the object model. # 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. # description of this parameter.
# #
# Returns: a list that describe the properties of the object. # Returns: a list that describe the properties of the object.
@ -129,12 +129,12 @@
# #
# Set a property value. # 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 # @property: the property name to set
# #
# @value: a value who's type is appropriate for the property type. # @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 # Since: 1.2
# #
@ -153,7 +153,7 @@
## ##
# @ObjectTypeInfo: # @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 # @name: the type name found in the search
# #
@ -193,6 +193,7 @@
# #
# @typename: the type name of an object # @typename: the type name of an object
# #
#
# .. note:: Objects can create properties at runtime, for example to # .. note:: Objects can create properties at runtime, for example to
# describe links between different devices and/or objects. These # describe links between different devices and/or objects. These
# properties are not included in the output of this command. # properties are not included in the output of this command.
@ -787,7 +788,7 @@
# #
# Properties for x-remote-object objects. # 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 # @devid: the id of the device to be associated with the file
# descriptor # descriptor
@ -816,7 +817,7 @@
# #
# Properties for iommufd objects. # 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 # which represents a pre-opened /dev/iommu. This allows the
# iommufd object to be shared across several subsystems (VFIO, # iommufd object to be shared across several subsystems (VFIO,
# VDPA, ...), and the file descriptor to be shared with other # VDPA, ...), and the file descriptor to be shared with other