mirror of
https://github.com/izzy2lost/xemu.git
synced 2026-07-06 00:20:22 -07:00
docs/interop: Refill QAPI doc comments to conform to conventions
For legibility, wrap text paragraphs so every line is at most 70 characters long. Consistently separate sentences with two spaces. Consistently separate member descriptions with a blank line. Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru> Message-ID: <20251103082354.3273027-7-armbru@redhat.com>
This commit is contained in:
+213
-227
File diff suppressed because it is too large
Load Diff
@@ -21,19 +21,33 @@
|
||||
# List the various vhost user backend types.
|
||||
#
|
||||
# @9p: 9p virtio console
|
||||
#
|
||||
# @balloon: virtio balloon
|
||||
#
|
||||
# @block: virtio block
|
||||
#
|
||||
# @caif: virtio caif
|
||||
#
|
||||
# @console: virtio console
|
||||
#
|
||||
# @crypto: virtio crypto
|
||||
#
|
||||
# @gpu: virtio gpu
|
||||
#
|
||||
# @input: virtio input
|
||||
#
|
||||
# @net: virtio net
|
||||
#
|
||||
# @rng: virtio rng
|
||||
#
|
||||
# @rpmsg: virtio remote processor messaging
|
||||
#
|
||||
# @rproc-serial: virtio remoteproc serial link
|
||||
#
|
||||
# @scsi: virtio scsi
|
||||
#
|
||||
# @vsock: virtio vsock transport
|
||||
#
|
||||
# @fs: virtio fs (since 4.2)
|
||||
#
|
||||
# Since: 4.0
|
||||
@@ -65,6 +79,7 @@
|
||||
# List of vhost user "block" features.
|
||||
#
|
||||
# @read-only: The --read-only command line option is supported.
|
||||
#
|
||||
# @blk-file: The --blk-file command line option is supported.
|
||||
#
|
||||
# Since: 5.0
|
||||
@@ -96,6 +111,7 @@
|
||||
# List of vhost user "input" features.
|
||||
#
|
||||
# @evdev-path: The --evdev-path command line option is supported.
|
||||
#
|
||||
# @no-grab: The --no-grab command line option is supported.
|
||||
#
|
||||
# Since: 4.0
|
||||
@@ -127,6 +143,7 @@
|
||||
# List of vhost user "gpu" features.
|
||||
#
|
||||
# @render-node: The --render-node command line option is supported.
|
||||
#
|
||||
# @virgl: The --virgl command line option is supported.
|
||||
#
|
||||
# Since: 4.0
|
||||
@@ -177,36 +194,39 @@
|
||||
# Describes a vhost user backend to management software.
|
||||
#
|
||||
# It is possible for multiple @VhostUserBackend elements to match the
|
||||
# search criteria of management software. Applications thus need rules
|
||||
# to pick one of the many matches, and users need the ability to
|
||||
# search criteria of management software. Applications thus need
|
||||
# rules to pick one of the many matches, and users need the ability to
|
||||
# override distro defaults.
|
||||
#
|
||||
# It is recommended to create vhost user backend JSON files (each
|
||||
# containing a single @VhostUserBackend root element) with a
|
||||
# double-digit prefix, for example "50-qemu-gpu.json",
|
||||
# "50-crosvm-gpu.json", etc, so they can be sorted in predictable
|
||||
# order. The backend JSON files should be searched for in three
|
||||
# order. The backend JSON files should be searched for in three
|
||||
# directories:
|
||||
#
|
||||
# - /usr/share/qemu/vhost-user -- populated by distro-provided
|
||||
# packages (XDG_DATA_DIRS covers
|
||||
# /usr/share by default),
|
||||
#
|
||||
# - /etc/qemu/vhost-user -- exclusively for sysadmins' local additions,
|
||||
# - /etc/qemu/vhost-user -- exclusively for sysadmins' local
|
||||
# additions,
|
||||
#
|
||||
# - $XDG_CONFIG_HOME/qemu/vhost-user -- exclusively for per-user local
|
||||
# additions (XDG_CONFIG_HOME
|
||||
# defaults to $HOME/.config).
|
||||
# - $XDG_CONFIG_HOME/qemu/vhost-user -- exclusively for per-user
|
||||
# local additions
|
||||
# (XDG_CONFIG_HOME defaults to
|
||||
# $HOME/.config).
|
||||
#
|
||||
# Top-down, the list of directories goes from general to specific.
|
||||
#
|
||||
# Management software should build a list of files from all three
|
||||
# locations, then sort the list by filename (i.e., basename
|
||||
# component). Management software should choose the first JSON file on
|
||||
# the sorted list that matches the search criteria. If a more specific
|
||||
# directory has a file with same name as a less specific directory,
|
||||
# then the file in the more specific directory takes effect. If the
|
||||
# more specific file is zero length, it hides the less specific one.
|
||||
# component). Management software should choose the first JSON file
|
||||
# on the sorted list that matches the search criteria. If a more
|
||||
# specific directory has a file with same name as a less specific
|
||||
# directory, then the file in the more specific directory takes
|
||||
# effect. If the more specific file is zero length, it hides the less
|
||||
# specific one.
|
||||
#
|
||||
# For example, if a distro ships
|
||||
#
|
||||
@@ -214,7 +234,8 @@
|
||||
#
|
||||
# - /usr/share/qemu/vhost-user/50-crosvm-gpu.json
|
||||
#
|
||||
# then the sysadmin can prevent the default QEMU GPU being used at all with
|
||||
# then the sysadmin can prevent the default QEMU GPU being used at all
|
||||
# with
|
||||
#
|
||||
# $ touch /etc/qemu/vhost-user/50-qemu-gpu.json
|
||||
#
|
||||
@@ -233,15 +254,15 @@
|
||||
# @type: The vhost user backend type.
|
||||
#
|
||||
# @description: Provides a human-readable description of the backend.
|
||||
# Management software may or may not display @description.
|
||||
# Management software may or may not display @description.
|
||||
#
|
||||
# @binary: Absolute path to the backend binary.
|
||||
#
|
||||
# @tags: An optional list of auxiliary strings associated with the
|
||||
# backend for which @description is not appropriate, due to the
|
||||
# latter's possible exposure to the end-user. @tags serves
|
||||
# development and debugging purposes only, and management
|
||||
# software shall explicitly ignore it.
|
||||
# backend for which @description is not appropriate, due to the
|
||||
# latter's possible exposure to the end-user. @tags serves
|
||||
# development and debugging purposes only, and management software
|
||||
# shall explicitly ignore it.
|
||||
#
|
||||
# Since: 4.0
|
||||
#
|
||||
|
||||
Reference in New Issue
Block a user