diff options
| author | John Snow <jsnow@redhat.com> | 2025-07-11 01:39:58 -0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2025-07-14 12:58:13 +0200 |
| commit | 91581b49e1d1910c1e5af641e7b8afa95c1b0a53 (patch) | |
| tree | 6694a09782449fba3206d7fe376d35f1dca32632 | |
| parent | b9abf7dd3f926e50029bd450e2d9c7cd2f1dde51 (diff) | |
| download | qemu-91581b49e1d1910c1e5af641e7b8afa95c1b0a53.zip qemu-91581b49e1d1910c1e5af641e7b8afa95c1b0a53.tar.gz qemu-91581b49e1d1910c1e5af641e7b8afa95c1b0a53.tar.bz2 | |
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>
| -rw-r--r-- | qapi/qdev.json | 4 | ||||
| -rw-r--r-- | qapi/qom.json | 13 |
2 files changed, 9 insertions, 8 deletions
diff --git a/qapi/qdev.json b/qapi/qdev.json index 6441357..e14a0c9 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 aa09edd..4e85baa 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 |