aboutsummaryrefslogtreecommitdiff
path: root/qapi/qom.json
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2023-04-28 12:54:29 +0200
committerMarkus Armbruster <armbru@redhat.com>2023-05-10 10:01:01 +0200
commita937b6aa739f65f2cae2ad9a7eb65a309ad2a359 (patch)
treec11a2c7b6fc5b850ef4dd6b613902759824779a5 /qapi/qom.json
parent059d341a67bb660a7957cb62a6a860c92c2fb64a (diff)
qapi: Reformat doc comments to conform to current conventions
Change # @name: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed # do eiusmod tempor incididunt ut labore et dolore magna aliqua. to # @name: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed # do eiusmod tempor incididunt ut labore et dolore magna aliqua. See recent commit "qapi: Relax doc string @name: description indentation rules" for rationale. Reflow paragraphs to 70 columns width, and consistently use two spaces to separate sentences. To check the generated documentation does not change, I compared the generated HTML before and after this commit with "wdiff -3". Finds no differences. Comparing with diff is not useful, as the reflown paragraphs are visible there. Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-Id: <20230428105429.1687850-18-armbru@redhat.com> Reviewed-by: Juan Quintela <quintela@redhat.com> Acked-by: Lukas Straub <lukasstraub2@web.de> [Straightforward conflicts in qapi/audio.json qapi/misc-target.json qapi/run-state.json resolved]
Diffstat (limited to 'qapi/qom.json')
-rw-r--r--qapi/qom.json404
1 files changed, 210 insertions, 194 deletions
diff --git a/qapi/qom.json b/qapi/qom.json
index 2a3891e3cb..f61badaba4 100644
--- a/qapi/qom.json
+++ b/qapi/qom.json
@@ -18,17 +18,20 @@
#
# @name: the name of the property
#
-# @type: the type of the property. This will typically come in one of four
-# forms:
+# @type: the type of the property. This will typically come in one of
+# four forms:
#
-# 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
-# These types are mapped to the appropriate JSON type.
+# 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or
+# 'double'. These types are mapped to the appropriate JSON
+# type.
#
-# 2) A child type in the form 'child<subtype>' where subtype is a qdev
-# device type name. Child properties create the composition tree.
+# 2) A child type in the form 'child<subtype>' where subtype is a
+# qdev device type name. Child properties create the
+# composition tree.
#
-# 3) A link type in the form 'link<subtype>' where subtype is a qdev
-# device type name. Link properties form the device model graph.
+# 3) A link type in the form 'link<subtype>' where subtype is a
+# qdev device type name. Link properties form the device model
+# graph.
#
# @description: if specified, the description of the property.
#
@@ -45,14 +48,14 @@
##
# @qom-list:
#
-# This command will list any properties of a object given a path in the object
-# model.
+# This command will list any properties of a object given a path in
+# the object model.
#
-# @path: the path within the object model. See @qom-get for a description of
-# this parameter.
+# @path: the path within the object model. See @qom-get for a
+# description of this parameter.
#
-# Returns: a list of @ObjectPropertyInfo that describe the properties of the
-# object.
+# Returns: a list of @ObjectPropertyInfo that describe the properties
+# of the object.
#
# Since: 1.2
#
@@ -64,7 +67,6 @@
# { "name": "parallel0", "type": "child<chardev-vc>" },
# { "name": "serial0", "type": "child<chardev-vc>" },
# { "name": "mon0", "type": "child<chardev-stdio>" } ] }
-#
##
{ 'command': 'qom-list',
'data': { 'path': 'str' },
@@ -74,32 +76,31 @@
##
# @qom-get:
#
-# This command will get a property from a object model path and return the
-# value.
+# This command will get a property from a object model path and return
+# the value.
#
-# @path: The path within the object model. There are two forms of supported
-# paths--absolute and partial paths.
+# @path: The path within the object model. There are two forms of
+# supported paths--absolute and partial paths.
#
-# Absolute paths are derived from the root object and can follow child<>
-# or link<> properties. Since they can follow link<> properties, they
-# can be arbitrarily long. Absolute paths look like absolute filenames
-# and are prefixed with a leading slash.
+# Absolute paths are derived from the root object and can follow
+# child<> or link<> properties. Since they can follow link<>
+# properties, they can be arbitrarily long. Absolute paths look
+# like absolute filenames and are prefixed with a leading slash.
#
-# Partial paths look like relative filenames. They do not begin
-# with a prefix. The matching rules for partial paths are subtle but
-# designed to make specifying objects easy. At each level of the
-# composition tree, the partial path is matched as an absolute path.
-# The first match is not returned. At least two matches are searched
-# for. A successful result is only returned if only one match is
-# found. If more than one match is found, a flag is return to
-# indicate that the match was ambiguous.
+# Partial paths look like relative filenames. They do not begin
+# with a prefix. The matching rules for partial paths are subtle
+# but designed to make specifying objects easy. At each level of
+# the composition tree, the partial path is matched as an absolute
+# path. The first match is not returned. At least two matches
+# are searched for. A successful result is only returned if only
+# one match is found. If more than one match is found, a flag is
+# return to indicate that the match was ambiguous.
#
# @property: The property name to read
#
-# Returns: The property value. The type depends on the property
-# type. child<> and link<> properties are returned as #str
-# pathnames. All integer property types (u8, u16, etc) are
-# returned as #int.
+# Returns: The property value. The type depends on the property type.
+# child<> and link<> properties are returned as #str pathnames.
+# All integer property types (u8, u16, etc) are returned as #int.
#
# Since: 1.2
#
@@ -118,7 +119,6 @@
# "arguments": { "path": "unattached/sysbus",
# "property": "type" } }
# <- { "return": "System" }
-#
##
{ 'command': 'qom-get',
'data': { 'path': 'str', 'property': 'str' },
@@ -134,8 +134,8 @@
#
# @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.
+# @value: a value who's type is appropriate for the property type.
+# See @qom-get for a description of type mapping.
#
# Since: 1.2
#
@@ -146,7 +146,6 @@
# "property": "graphics",
# "value": false } }
# <- { "return": {} }
-#
##
{ 'command': 'qom-set',
'data': { 'path': 'str', 'property': 'str', 'value': 'any' },
@@ -160,7 +159,7 @@
# @name: the type name found in the search
#
# @abstract: the type is abstract and can't be directly instantiated.
-# Omitted if false. (since 2.10)
+# Omitted if false. (since 2.10)
#
# @parent: Name of parent type, if any (since 2.10)
#
@@ -174,11 +173,13 @@
#
# This command will return a list of types given search parameters
#
-# @implements: if specified, only return types that implement this type name
+# @implements: if specified, only return types that implement this
+# type name
#
# @abstract: if true, include abstract types in the results
#
-# Returns: a list of @ObjectTypeInfo or an empty list if no results are found
+# Returns: a list of @ObjectTypeInfo or an empty list if no results
+# are found
#
# Since: 1.1
##
@@ -194,9 +195,9 @@
#
# @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.
+# 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.
#
# Returns: a list of ObjectPropertyInfo describing object properties
#
@@ -214,7 +215,8 @@
#
# @if: interface name of the host system CAN bus to connect to
#
-# @canbus: object ID of the can-bus object to connect to the host interface
+# @canbus: object ID of the can-bus object to connect to the host
+# interface
#
# Since: 2.12
##
@@ -227,34 +229,35 @@
#
# Properties for colo-compare objects.
#
-# @primary_in: name of the character device backend to use for the primary
-# input (incoming packets are redirected to @outdev)
+# @primary_in: name of the character device backend to use for the
+# primary input (incoming packets are redirected to @outdev)
#
-# @secondary_in: name of the character device backend to use for secondary
-# input (incoming packets are only compared to the input on
-# @primary_in and then dropped)
+# @secondary_in: name of the character device backend to use for
+# secondary input (incoming packets are only compared to the input
+# on @primary_in and then dropped)
#
# @outdev: name of the character device backend to use for output
#
# @iothread: name of the iothread to run in
#
-# @notify_dev: name of the character device backend to be used to communicate
-# with the remote colo-frame (only for Xen COLO)
+# @notify_dev: name of the character device backend to be used to
+# communicate with the remote colo-frame (only for Xen COLO)
#
-# @compare_timeout: the maximum time to hold a packet from @primary_in for
-# comparison with an incoming packet on @secondary_in in
-# milliseconds (default: 3000)
+# @compare_timeout: the maximum time to hold a packet from @primary_in
+# for comparison with an incoming packet on @secondary_in in
+# milliseconds (default: 3000)
#
-# @expired_scan_cycle: the interval at which colo-compare checks whether
-# packets from @primary have timed out, in milliseconds
-# (default: 3000)
+# @expired_scan_cycle: the interval at which colo-compare checks
+# whether packets from @primary have timed out, in milliseconds
+# (default: 3000)
#
-# @max_queue_size: the maximum number of packets to keep in the queue for
-# comparing with incoming packets from @secondary_in. If the
-# queue is full and additional packets are received, the
-# additional packets are dropped. (default: 1024)
+# @max_queue_size: the maximum number of packets to keep in the queue
+# for comparing with incoming packets from @secondary_in. If the
+# queue is full and additional packets are received, the
+# additional packets are dropped. (default: 1024)
#
-# @vnet_hdr_support: if true, vnet header support is enabled (default: false)
+# @vnet_hdr_support: if true, vnet header support is enabled
+# (default: false)
#
# Since: 2.8
##
@@ -272,11 +275,12 @@
##
# @CryptodevBackendProperties:
#
-# Properties for cryptodev-backend and cryptodev-backend-builtin objects.
+# Properties for cryptodev-backend and cryptodev-backend-builtin
+# objects.
#
-# @queues: the number of queues for the cryptodev backend. Ignored for
-# cryptodev-backend and must be 1 for cryptodev-backend-builtin.
-# (default: 1)
+# @queues: the number of queues for the cryptodev backend. Ignored
+# for cryptodev-backend and must be 1 for
+# cryptodev-backend-builtin. (default: 1)
#
# @throttle-bps: limit total bytes per second (Since 8.0)
#
@@ -294,8 +298,8 @@
#
# Properties for cryptodev-vhost-user objects.
#
-# @chardev: the name of a Unix domain socket character device that connects to
-# the vhost-user server
+# @chardev: the name of a Unix domain socket character device that
+# connects to the vhost-user server
#
# Since: 2.12
##
@@ -310,8 +314,8 @@
#
# @addr: the name of the DBus bus to connect to
#
-# @id-list: a comma separated list of DBus IDs of helpers whose data should be
-# included in the VM state on migration
+# @id-list: a comma separated list of DBus IDs of helpers whose data
+# should be included in the VM state on migration
#
# Since: 5.0
##
@@ -322,7 +326,8 @@
##
# @NetfilterInsert:
#
-# Indicates where to insert a netfilter relative to a given other filter.
+# Indicates where to insert a netfilter relative to a given other
+# filter.
#
# @before: insert before the specified filter
#
@@ -342,20 +347,20 @@
#
# @queue: indicates which queue(s) to filter (default: all)
#
-# @status: indicates whether the filter is enabled ("on") or disabled ("off")
-# (default: "on")
+# @status: indicates whether the filter is enabled ("on") or disabled
+# ("off") (default: "on")
#
-# @position: specifies where the filter should be inserted in the filter list.
-# "head" means the filter is inserted at the head of the filter list,
-# before any existing filters.
-# "tail" means the filter is inserted at the tail of the filter list,
-# behind any existing filters (default).
-# "id=<id>" means the filter is inserted before or behind the filter
-# specified by <id>, depending on the @insert property.
-# (default: "tail")
+# @position: specifies where the filter should be inserted in the
+# filter list. "head" means the filter is inserted at the head of
+# the filter list, before any existing filters. "tail" means the
+# filter is inserted at the tail of the filter list, behind any
+# existing filters (default). "id=<id>" means the filter is
+# inserted before or behind the filter specified by <id>,
+# depending on the @insert property. (default: "tail")
#
-# @insert: where to insert the filter relative to the filter given in @position.
-# Ignored if @position is "head" or "tail". (default: behind)
+# @insert: where to insert the filter relative to the filter given in
+# @position. Ignored if @position is "head" or "tail".
+# (default: behind)
#
# Since: 2.5
##
@@ -371,8 +376,9 @@
#
# Properties for filter-buffer objects.
#
-# @interval: a non-zero interval in microseconds. All packets arriving in the
-# given interval are delayed until the end of the interval.
+# @interval: a non-zero interval in microseconds. All packets
+# arriving in the given interval are delayed until the end of the
+# interval.
#
# Since: 2.5
##
@@ -387,7 +393,8 @@
#
# @file: the filename where the dumped packets should be stored
#
-# @maxlen: maximum number of bytes in a packet that are stored (default: 65536)
+# @maxlen: maximum number of bytes in a packet that are stored
+# (default: 65536)
#
# Since: 2.5
##
@@ -401,10 +408,11 @@
#
# Properties for filter-mirror objects.
#
-# @outdev: the name of a character device backend to which all incoming packets
-# are mirrored
+# @outdev: the name of a character device backend to which all
+# incoming packets are mirrored
#
-# @vnet_hdr_support: if true, vnet header support is enabled (default: false)
+# @vnet_hdr_support: if true, vnet header support is enabled
+# (default: false)
#
# Since: 2.6
##
@@ -418,16 +426,17 @@
#
# Properties for filter-redirector objects.
#
-# At least one of @indev or @outdev must be present. If both are present, they
-# must not refer to the same character device backend.
+# At least one of @indev or @outdev must be present. If both are
+# present, they must not refer to the same character device backend.
#
-# @indev: the name of a character device backend from which packets are
-# received and redirected to the filtered network device
+# @indev: the name of a character device backend from which packets
+# are received and redirected to the filtered network device
#
-# @outdev: the name of a character device backend to which all incoming packets
-# are redirected
+# @outdev: the name of a character device backend to which all
+# incoming packets are redirected
#
-# @vnet_hdr_support: if true, vnet header support is enabled (default: false)
+# @vnet_hdr_support: if true, vnet header support is enabled
+# (default: false)
#
# Since: 2.6
##
@@ -442,7 +451,8 @@
#
# Properties for filter-rewriter objects.
#
-# @vnet_hdr_support: if true, vnet header support is enabled (default: false)
+# @vnet_hdr_support: if true, vnet header support is enabled
+# (default: false)
#
# Since: 2.8
##
@@ -455,17 +465,18 @@
#
# Properties for input-barrier objects.
#
-# @name: the screen name as declared in the screens section of barrier.conf
+# @name: the screen name as declared in the screens section of
+# barrier.conf
#
# @server: hostname of the Barrier server (default: "localhost")
#
# @port: TCP port of the Barrier server (default: "24800")
#
# @x-origin: x coordinate of the leftmost pixel on the guest screen
-# (default: "0")
+# (default: "0")
#
# @y-origin: y coordinate of the topmost pixel on the guest screen
-# (default: "0")
+# (default: "0")
#
# @width: the width of secondary screen in pixels (default: "1920")
#
@@ -489,13 +500,13 @@
#
# @evdev: the path of the host evdev device to use
#
-# @grab_all: if true, grab is toggled for all devices (e.g. both keyboard and
-# mouse) instead of just one device (default: false)
+# @grab_all: if true, grab is toggled for all devices (e.g. both
+# keyboard and mouse) instead of just one device (default: false)
#
# @repeat: enables auto-repeat events (default: false)
#
# @grab-toggle: the key or key combination that toggles device grab
-# (default: ctrl-ctrl)
+# (default: ctrl-ctrl)
#
# Since: 2.6
##
@@ -510,15 +521,15 @@
#
# Common properties for event loops
#
-# @aio-max-batch: maximum number of requests in a batch for the AIO engine,
-# 0 means that the engine will use its default.
-# (default: 0)
+# @aio-max-batch: maximum number of requests in a batch for the AIO
+# engine, 0 means that the engine will use its default.
+# (default: 0)
#
-# @thread-pool-min: minimum number of threads reserved in the thread pool
-# (default:0)
+# @thread-pool-min: minimum number of threads reserved in the thread
+# pool (default:0)
#
-# @thread-pool-max: maximum number of threads the thread pool can contain
-# (default:64)
+# @thread-pool-max: maximum number of threads the thread pool can
+# contain (default:64)
#
# Since: 7.1
##
@@ -532,17 +543,17 @@
#
# Properties for iothread objects.
#
-# @poll-max-ns: the maximum number of nanoseconds to busy wait for events.
-# 0 means polling is disabled (default: 32768 on POSIX hosts,
-# 0 otherwise)
+# @poll-max-ns: the maximum number of nanoseconds to busy wait for
+# events. 0 means polling is disabled (default: 32768 on POSIX
+# hosts, 0 otherwise)
#
-# @poll-grow: the multiplier used to increase the polling time when the
-# algorithm detects it is missing events due to not polling long
-# enough. 0 selects a default behaviour (default: 0)
+# @poll-grow: the multiplier used to increase the polling time when
+# the algorithm detects it is missing events due to not polling
+# long enough. 0 selects a default behaviour (default: 0)
#
# @poll-shrink: the divisor used to decrease the polling time when the
-# algorithm detects it is spending too long polling without
-# encountering events. 0 selects a default behaviour (default: 0)
+# algorithm detects it is spending too long polling without
+# encountering events. 0 selects a default behaviour (default: 0)
#
# The @aio-max-batch option is available since 6.1.
#
@@ -570,11 +581,11 @@
#
# Properties for objects of classes derived from memory-backend.
#
-# @merge: if true, mark the memory as mergeable (default depends on the machine
-# type)
+# @merge: if true, mark the memory as mergeable (default depends on
+# the machine type)
#
-# @dump: if true, include the memory in core dumps (default depends on the
-# machine type)
+# @dump: if true, include the memory in core dumps (default depends on
+# the machine type)
#
# @host-nodes: the list of NUMA host nodes to bind the memory to
#
@@ -582,31 +593,31 @@
#
# @prealloc: if true, preallocate memory (default: false)
#
-# @prealloc-threads: number of CPU threads to use for prealloc (default: 1)
+# @prealloc-threads: number of CPU threads to use for prealloc
+# (default: 1)
#
-# @prealloc-context: thread context to use for creation of preallocation threads
-# (default: none) (since 7.2)
+# @prealloc-context: thread context to use for creation of
+# preallocation threads (default: none) (since 7.2)
#
-# @share: if false, the memory is private to QEMU; if true, it is shared
-# (default: false)
+# @share: if false, the memory is private to QEMU; if true, it is
+# shared (default: false)
#
# @reserve: if true, reserve swap space (or huge pages) if applicable
-# (default: true) (since 6.1)
+# (default: true) (since 6.1)
#
# @size: size of the memory region in bytes
#
-# @x-use-canonical-path-for-ramblock-id: if true, the canonical path is used
-# for ramblock-id. Disable this for 4.0
-# machine types or older to allow
-# migration with newer QEMU versions.
-# (default: false generally,
-# but true for machine types <= 4.0)
+# @x-use-canonical-path-for-ramblock-id: if true, the canonical path
+# is used for ramblock-id. Disable this for 4.0 machine types or
+# older to allow migration with newer QEMU versions.
+# (default: false generally, but true for machine types <= 4.0)
#
-# Note: prealloc=true and reserve=false cannot be set at the same time. With
-# reserve=true, the behavior depends on the operating system: for example,
-# Linux will not reserve swap space for shared file mappings --
-# "not applicable". In contrast, reserve=false will bail out if it cannot
-# be configured accordingly.
+# Note: prealloc=true and reserve=false cannot be set at the same
+# time. With reserve=true, the behavior depends on the operating
+# system: for example, Linux will not reserve swap space for
+# shared file mappings -- "not applicable". In contrast,
+# reserve=false will bail out if it cannot be configured
+# accordingly.
#
# Since: 2.1
##
@@ -628,27 +639,29 @@
#
# Properties for memory-backend-file objects.
#
-# @align: the base address alignment when QEMU mmap(2)s @mem-path. Some
-# backend stores specified by @mem-path require an alignment different
-# than the default one used by QEMU, e.g. the device DAX /dev/dax0.0
-# requires 2M alignment rather than 4K. In such cases, users can
-# specify the required alignment via this option.
-# 0 selects a default alignment (currently the page size). (default: 0)
+# @align: the base address alignment when QEMU mmap(2)s @mem-path.
+# Some backend stores specified by @mem-path require an alignment
+# different than the default one used by QEMU, e.g. the device DAX
+# /dev/dax0.0 requires 2M alignment rather than 4K. In such cases,
+# users can specify the required alignment via this option. 0
+# selects a default alignment (currently the page size).
+# (default: 0)
#
-# @discard-data: if true, the file contents can be destroyed when QEMU exits,
-# to avoid unnecessarily flushing data to the backing file. Note
-# that @discard-data is only an optimization, and QEMU might
-# not discard file contents if it aborts unexpectedly or is
-# terminated using SIGKILL. (default: false)
+# @discard-data: if true, the file contents can be destroyed when QEMU
+# exits, to avoid unnecessarily flushing data to the backing file.
+# Note that @discard-data is only an optimization, and QEMU might
+# not discard file contents if it aborts unexpectedly or is
+# terminated using SIGKILL. (default: false)
#
-# @mem-path: the path to either a shared memory or huge page filesystem mount
+# @mem-path: the path to either a shared memory or huge page
+# filesystem mount
#
-# @pmem: specifies whether the backing file specified by @mem-path is in
-# host persistent memory that can be accessed using the SNIA NVM
-# programming model (e.g. Intel NVDIMM).
+# @pmem: specifies whether the backing file specified by @mem-path is
+# in host persistent memory that can be accessed using the SNIA
+# NVM programming model (e.g. Intel NVDIMM).
#
-# @readonly: if true, the backing file is opened read-only; if false, it is
-# opened read-write. (default: false)
+# @readonly: if true, the backing file is opened read-only; if false,
+# it is opened read-write. (default: false)
#
# Since: 2.1
##
@@ -667,16 +680,16 @@
#
# The @share boolean option is true by default with memfd.
#
-# @hugetlb: if true, the file to be created resides in the hugetlbfs filesystem
-# (default: false)
+# @hugetlb: if true, the file to be created resides in the hugetlbfs
+# filesystem (default: false)
#
-# @hugetlbsize: the hugetlb page size on systems that support multiple hugetlb
-# page sizes (it must be a power of 2 value supported by the
-# system). 0 selects a default page size. This option is ignored
-# if @hugetlb is false. (default: 0)
+# @hugetlbsize: the hugetlb page size on systems that support multiple
+# hugetlb page sizes (it must be a power of 2 value supported by
+# the system). 0 selects a default page size. This option is
+# ignored if @hugetlb is false. (default: 0)
#
-# @seal: if true, create a sealed-file, which will block further resizing of
-# the memory (default: true)
+# @seal: if true, create a sealed-file, which will block further
+# resizing of the memory (default: true)
#
# Since: 2.12
##
@@ -708,7 +721,8 @@
#
# Properties for pr-manager-helper objects.
#
-# @path: the path to a Unix domain socket for connecting to the external helper
+# @path: the path to a Unix domain socket for connecting to the
+# external helper
#
# Since: 2.11
##
@@ -737,7 +751,8 @@
#
# @fd: file descriptor name previously passed via 'getfd' command
#
-# @devid: the id of the device to be associated with the file descriptor
+# @devid: the id of the device to be associated with the file
+# descriptor
#
# Since: 6.0
##
@@ -763,13 +778,15 @@
#
# Properties for objects of classes derived from rng.
#
-# @opened: if true, the device is opened immediately when applying this option
-# and will probably fail when processing the next option. Don't use;
-# only provided for compatibility. (default: false)
+# @opened: if true, the device is opened immediately when applying
+# this option and will probably fail when processing the next
+# option. Don't use; only provided for compatibility.
+# (default: false)
#
# Features:
-# @deprecated: Member @opened is deprecated. Setting true doesn't make sense,
-# and false is already the default.
+#
+# @deprecated: Member @opened is deprecated. Setting true doesn't
+# make sense, and false is already the default.
#
# Since: 1.3
##
@@ -781,8 +798,8 @@
#
# Properties for rng-egd objects.
#
-# @chardev: the name of a character device backend that provides the connection
-# to the RNG daemon
+# @chardev: the name of a character device backend that provides the
+# connection to the RNG daemon
#
# Since: 1.3
##
@@ -795,8 +812,8 @@
#
# Properties for rng-random objects.
#
-# @filename: the filename of the device on the host to obtain entropy from
-# (default: "/dev/urandom")
+# @filename: the filename of the device on the host to obtain entropy
+# from (default: "/dev/urandom")
#
# Since: 1.3
##
@@ -822,11 +839,11 @@
# @cbitpos: C-bit location in page table entry (default: 0)
#
# @reduced-phys-bits: number of bits in physical addresses that become
-# unavailable when SEV is enabled
+# unavailable when SEV is enabled
#
# @kernel-hashes: if true, add hashes of kernel/initrd/cmdline to a
-# designated guest firmware page for measured boot
-# with -kernel (default: false) (since 6.2)
+# designated guest firmware page for measured boot with -kernel
+# (default: false) (since 6.2)
#
# Since: 2.12
##
@@ -845,15 +862,15 @@
#
# Properties for thread context objects.
#
-# @cpu-affinity: the list of host CPU numbers used as CPU affinity for all
-# threads created in the thread context (default: QEMU main
-# thread CPU affinity)
+# @cpu-affinity: the list of host CPU numbers used as CPU affinity for
+# all threads created in the thread context (default: QEMU main
+# thread CPU affinity)
#
-# @node-affinity: the list of host node numbers that will be resolved to a
-# list of host CPU numbers used as CPU affinity. This is a
-# shortcut for specifying the list of host CPU numbers
-# belonging to the host nodes manually by setting
-# @cpu-affinity. (default: QEMU main thread affinity)
+# @node-affinity: the list of host node numbers that will be resolved
+# to a list of host CPU numbers used as CPU affinity. This is a
+# shortcut for specifying the list of host CPU numbers belonging
+# to the host nodes manually by setting @cpu-affinity.
+# (default: QEMU main thread affinity)
#
# Since: 7.2
##
@@ -866,6 +883,7 @@
# @ObjectType:
#
# Features:
+#
# @unstable: Member @x-remote-object is experimental.
#
# Since: 6.0
@@ -998,8 +1016,8 @@
#
# Create a QOM object.
#
-# Returns: Nothing on success
-# Error if @qom-type is not a valid class name
+# Returns: Nothing on success Error if @qom-type is not a valid class
+# name
#
# Since: 2.0
#
@@ -1009,7 +1027,6 @@
# "arguments": { "qom-type": "rng-random", "id": "rng1",
# "filename": "/dev/hwrng" } }
# <- { "return": {} }
-#
##
{ 'command': 'object-add', 'data': 'ObjectOptions', 'boxed': true,
'allow-preconfig': true }
@@ -1021,8 +1038,8 @@
#
# @id: the name of the QOM object to remove
#
-# Returns: Nothing on success
-# Error if @id is not a valid id for a QOM object
+# Returns: Nothing on success Error if @id is not a valid id for a QOM
+# object
#
# Since: 2.0
#
@@ -1030,7 +1047,6 @@
#
# -> { "execute": "object-del", "arguments": { "id": "rng1" } }
# <- { "return": {} }
-#
##
{ 'command': 'object-del', 'data': {'id': 'str'},
'allow-preconfig': true }