evan/qemu-xteink
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

qapi: Refill doc comments to conform to current conventions

Browse Source 
For legibility, wrap text paragraphs so every line is at most 70
characters long.

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 refilled
paragraphs are visible there.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240322140910.328840-11-armbru@redhat.com>
This commit is contained in:
Markus Armbruster
2024-03-22 15:09:08 +01:00
parent 1e6b0505c4
commit 209e64d9ed
12 changed files with 142 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files
qapi/qom.json
+17 -17
View File
@@ -668,19 +668,20 @@
# @readonly: if true, the backing file is opened read-only; if false,
# it is opened read-write. (default: false)
#
# @rom: whether to create Read Only Memory (ROM) that cannot be modified
# by the VM. Any write attempts to such ROM will be denied. Most
# use cases want writable RAM instead of ROM. However, selected use
# cases, like R/O NVDIMMs, can benefit from ROM. If set to 'on',
# create ROM; if set to 'off', create writable RAM; if set to
# 'auto', the value of the @readonly property is used. This
# property is primarily helpful when we want to have proper RAM in
# configurations that would traditionally create ROM before this
# property was introduced: VM templating, where we want to open a
# file readonly (@readonly set to true) and mark the memory to be
# private for QEMU (@share set to false). For this use case, we need
# writable RAM instead of ROM, and want to set this property to 'off'.
# (default: auto, since 8.2)
# @rom: whether to create Read Only Memory (ROM) that cannot be
# modified by the VM. Any write attempts to such ROM will be
# denied. Most use cases want writable RAM instead of ROM.
# However, selected use cases, like R/O NVDIMMs, can benefit from
# ROM. If set to 'on', create ROM; if set to 'off', create
# writable RAM; if set to 'auto', the value of the @readonly
# property is used. This property is primarily helpful when we
# want to have proper RAM in configurations that would
# traditionally create ROM before this property was introduced: VM
# templating, where we want to open a file readonly (@readonly set
# to true) and mark the memory to be private for QEMU (@share set
# to false). For this use case, we need writable RAM instead of
# ROM, and want to set this property to 'off'. (default: auto,
# since 8.2)
#
# Since: 2.1
##
@@ -801,10 +802,9 @@
#
# @fd: file descriptor name previously passed via 'getfd' command,
# which represents a pre-opened /dev/iommu. This allows the
# iommufd object to be shared accross several subsystems
# (VFIO, VDPA, ...), and the file descriptor to be shared
# with other process, e.g. DPDK. (default: QEMU opens
# /dev/iommu by itself)
# iommufd object to be shared accross several subsystems (VFIO,
# VDPA, ...), and the file descriptor to be shared with other
# process, e.g. DPDK. (default: QEMU opens /dev/iommu by itself)
#
# Since: 9.0
##