mirror of
https://github.com/qemu/qemu.git
synced 2025-08-15 22:31:15 +00:00
qga: Add cross-references
Enclose command and type names in `backquotes`, so they become links
in generated HTML.
We did this for qapi/ in merge commit 504632dcc6.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20250717115246.3830007-5-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
This commit is contained in:
Markus Armbruster
parent
ef7e21964d
commit
62e1fa22f5
@ -96,11 +96,11 @@
|
||||
# In cases where a partial stale response was previously received by
|
||||
# the client, this cannot always be done reliably. One particular
|
||||
# scenario being if qemu-ga responses are fed character-by-character
|
||||
# into a JSON parser. In these situations, using guest-sync-delimited
|
||||
# into a JSON parser. In these situations, using `guest-sync-delimited`
|
||||
# may be optimal.
|
||||
#
|
||||
# For clients that fetch responses line by line and convert them to
|
||||
# JSON objects, guest-sync should be sufficient, but note that in
|
||||
# JSON objects, `guest-sync` should be sufficient, but note that in
|
||||
# cases where the channel is dirty some attempts at parsing the
|
||||
# response may result in a parser error.
|
||||
#
|
||||
@ -217,7 +217,7 @@
|
||||
#
|
||||
# This command does NOT return a response on success. Success
|
||||
# condition is indicated by the VM exiting with a zero exit status or,
|
||||
# when running with --no-shutdown, by issuing the query-status QMP
|
||||
# when running with --no-shutdown, by issuing the `query-status` QMP
|
||||
# command to confirm the VM status is "shutdown".
|
||||
#
|
||||
# Since: 0.15.0
|
||||
@ -247,7 +247,7 @@
|
||||
#
|
||||
# Close an open file in the guest
|
||||
#
|
||||
# @handle: filehandle returned by guest-file-open
|
||||
# @handle: filehandle returned by `guest-file-open`
|
||||
#
|
||||
# Since: 0.15.0
|
||||
##
|
||||
@ -278,7 +278,7 @@
|
||||
# As this command is just for limited, ad-hoc debugging, such as log
|
||||
# file access, the number of bytes to read is limited to 48 MB.
|
||||
#
|
||||
# @handle: filehandle returned by guest-file-open
|
||||
# @handle: filehandle returned by `guest-file-open`
|
||||
#
|
||||
# @count: maximum number of bytes to read (default is 4KB, maximum is
|
||||
# 48MB)
|
||||
@ -309,7 +309,7 @@
|
||||
#
|
||||
# Write to an open file in the guest.
|
||||
#
|
||||
# @handle: filehandle returned by guest-file-open
|
||||
# @handle: filehandle returned by `guest-file-open`
|
||||
#
|
||||
# @buf-b64: base64-encoded string representing data to be written
|
||||
#
|
||||
@ -340,7 +340,7 @@
|
||||
##
|
||||
# @QGASeek:
|
||||
#
|
||||
# Symbolic names for use in @guest-file-seek
|
||||
# Symbolic names for use in `guest-file-seek`
|
||||
#
|
||||
# @set: Set to the specified offset (same effect as 'whence':0)
|
||||
#
|
||||
@ -355,7 +355,7 @@
|
||||
##
|
||||
# @GuestFileWhence:
|
||||
#
|
||||
# Controls the meaning of offset to @guest-file-seek.
|
||||
# Controls the meaning of offset to `guest-file-seek`.
|
||||
#
|
||||
# @value: Integral value (0 for set, 1 for cur, 2 for end), available
|
||||
# for historical reasons, and might differ from the host's or
|
||||
@ -375,7 +375,7 @@
|
||||
# current file position afterward. Also encapsulates ftell()'s
|
||||
# functionality, with offset=0 and whence=1.
|
||||
#
|
||||
# @handle: filehandle returned by guest-file-open
|
||||
# @handle: filehandle returned by `guest-file-open`
|
||||
#
|
||||
# @offset: bytes to skip over in the file stream
|
||||
#
|
||||
@ -393,7 +393,7 @@
|
||||
#
|
||||
# Write file changes buffered in userspace to disk/kernel buffers
|
||||
#
|
||||
# @handle: filehandle returned by guest-file-open
|
||||
# @handle: filehandle returned by `guest-file-open`
|
||||
#
|
||||
# Since: 0.15.0
|
||||
##
|
||||
@ -434,12 +434,12 @@
|
||||
# @guest-fsfreeze-freeze:
|
||||
#
|
||||
# Sync and freeze all freezable, local guest filesystems. If this
|
||||
# command succeeded, you may call @guest-fsfreeze-thaw later to
|
||||
# command succeeded, you may call `guest-fsfreeze-thaw` later to
|
||||
# unfreeze.
|
||||
#
|
||||
# On error, all filesystems will be thawed. If no filesystems are
|
||||
# frozen as a result of this call, then @guest-fsfreeze-status will
|
||||
# remain "thawed" and calling @guest-fsfreeze-thaw is not necessary.
|
||||
# frozen as a result of this call, then `guest-fsfreeze-status` will
|
||||
# remain "thawed" and calling `guest-fsfreeze-thaw` is not necessary.
|
||||
#
|
||||
# Returns: Number of file systems currently frozen.
|
||||
#
|
||||
@ -457,7 +457,7 @@
|
||||
# @guest-fsfreeze-freeze-list:
|
||||
#
|
||||
# Sync and freeze specified guest filesystems. See also
|
||||
# @guest-fsfreeze-freeze.
|
||||
# `guest-fsfreeze-freeze`.
|
||||
#
|
||||
# On error, all filesystems will be thawed.
|
||||
#
|
||||
@ -482,7 +482,7 @@
|
||||
# Returns: Number of file systems thawed by this call
|
||||
#
|
||||
# .. note:: If the return value does not match the previous call to
|
||||
# guest-fsfreeze-freeze, this likely means some freezable filesystems
|
||||
# `guest-fsfreeze-freeze`, this likely means some freezable filesystems
|
||||
# were unfrozen before this call, and that the filesystem state may
|
||||
# have changed before issuing this command.
|
||||
#
|
||||
@ -513,7 +513,7 @@
|
||||
##
|
||||
# @GuestFilesystemTrimResponse:
|
||||
#
|
||||
# @paths: list of @GuestFilesystemTrimResult per path that was trimmed
|
||||
# @paths: list of `GuestFilesystemTrimResult` per path that was trimmed
|
||||
#
|
||||
# Since: 2.4
|
||||
##
|
||||
@ -557,7 +557,7 @@
|
||||
#
|
||||
# This command does NOT return a response on success. There is a high
|
||||
# chance the command succeeded if the VM exits with a zero exit status
|
||||
# or, when running with --no-shutdown, by issuing the query-status QMP
|
||||
# or, when running with --no-shutdown, by issuing the `query-status` QMP
|
||||
# command to to confirm the VM status is "shutdown". However, the VM
|
||||
# could also exit (or set its status to "shutdown") due to other
|
||||
# reasons.
|
||||
@ -565,7 +565,7 @@
|
||||
# Errors:
|
||||
# - If suspend to disk is not supported, Unsupported
|
||||
#
|
||||
# .. note:: It's strongly recommended to issue the guest-sync command
|
||||
# .. note:: It's strongly recommended to issue the `guest-sync` command
|
||||
# before sending commands when the guest resumes.
|
||||
#
|
||||
# Since: 1.1
|
||||
@ -585,8 +585,8 @@
|
||||
# - pm-utils (via pm-hibernate)
|
||||
# - manual write into sysfs
|
||||
#
|
||||
# IMPORTANT: guest-suspend-ram requires working wakeup support in
|
||||
# QEMU. You should check QMP command query-current-machine returns
|
||||
# IMPORTANT: `guest-suspend-ram` requires working wakeup support in
|
||||
# QEMU. You should check QMP command `query-current-machine` returns
|
||||
# wakeup-suspend-support: true before issuing this command. Failure
|
||||
# in doing so can result in a suspended guest that QEMU will not be
|
||||
# able to awaken, forcing the user to power cycle the guest to bring
|
||||
@ -595,14 +595,14 @@
|
||||
# This command does NOT return a response on success. There are two
|
||||
# options to check for success:
|
||||
#
|
||||
# 1. Wait for the SUSPEND QMP event from QEMU
|
||||
# 2. Issue the query-status QMP command to confirm the VM status is
|
||||
# 1. Wait for the `SUSPEND` QMP event from QEMU
|
||||
# 2. Issue the `query-status` QMP command to confirm the VM status is
|
||||
# "suspended"
|
||||
#
|
||||
# Errors:
|
||||
# - If suspend to ram is not supported, Unsupported
|
||||
#
|
||||
# .. note:: It's strongly recommended to issue the guest-sync command
|
||||
# .. note:: It's strongly recommended to issue the `guest-sync` command
|
||||
# before sending commands when the guest resumes.
|
||||
#
|
||||
# Since: 1.1
|
||||
@ -621,8 +621,8 @@
|
||||
# - systemd hybrid-sleep
|
||||
# - pm-utils (via pm-suspend-hybrid)
|
||||
#
|
||||
# IMPORTANT: guest-suspend-hybrid requires working wakeup support in
|
||||
# QEMU. You should check QMP command query-current-machine returns
|
||||
# IMPORTANT: `guest-suspend-hybrid` requires working wakeup support in
|
||||
# QEMU. You should check QMP command `query-current-machine` returns
|
||||
# wakeup-suspend-support: true before issuing this command. Failure
|
||||
# in doing so can result in a suspended guest that QEMU will not be
|
||||
# able to awaken, forcing the user to power cycle the guest to bring
|
||||
@ -631,14 +631,14 @@
|
||||
# This command does NOT return a response on success. There are two
|
||||
# options to check for success:
|
||||
#
|
||||
# 1. Wait for the SUSPEND QMP event from QEMU
|
||||
# 2. Issue the query-status QMP command to confirm the VM status is
|
||||
# 1. Wait for the `SUSPEND` QMP event from QEMU
|
||||
# 2. Issue the `query-status` QMP command to confirm the VM status is
|
||||
# "suspended"
|
||||
#
|
||||
# Errors:
|
||||
# - If hybrid suspend is not supported, Unsupported
|
||||
#
|
||||
# .. note:: It's strongly recommended to issue the guest-sync command
|
||||
# .. note:: It's strongly recommended to issue the `guest-sync` command
|
||||
# before sending commands when the guest resumes.
|
||||
#
|
||||
# Since: 1.1
|
||||
@ -793,7 +793,7 @@
|
||||
# There's no restriction on list length or on repeating the same
|
||||
# @logical-id (with possibly different @online field). Preferably
|
||||
# the input list should describe a modified subset of
|
||||
# @guest-get-vcpus' return value.
|
||||
# `guest-get-vcpus`' return value.
|
||||
#
|
||||
# Returns: The length of the initial sublist that has been
|
||||
# successfully processed. The guest agent maximizes this value.
|
||||
@ -1069,7 +1069,7 @@
|
||||
#
|
||||
# Returns: The list of filesystems information mounted in the guest.
|
||||
# The returned mountpoints may be specified to
|
||||
# @guest-fsfreeze-freeze-list. Network filesystems (such as CIFS
|
||||
# `guest-fsfreeze-freeze-list`. Network filesystems (such as CIFS
|
||||
# and NFS) are not listed.
|
||||
#
|
||||
# Since: 2.2
|
||||
@ -1171,7 +1171,7 @@
|
||||
##
|
||||
# @GuestMemoryBlockResponse:
|
||||
#
|
||||
# @phys-index: same with the 'phys-index' member of @GuestMemoryBlock.
|
||||
# @phys-index: same with the 'phys-index' member of `GuestMemoryBlock`.
|
||||
#
|
||||
# @response: the result of memory block operation.
|
||||
#
|
||||
@ -1201,11 +1201,11 @@
|
||||
# guest-supported identifiers. There's no restriction on list
|
||||
# length or on repeating the same @phys-index (with possibly
|
||||
# different @online field). Preferably the input list should
|
||||
# describe a modified subset of @guest-get-memory-blocks' return
|
||||
# describe a modified subset of `guest-get-memory-blocks`' return
|
||||
# value.
|
||||
#
|
||||
# Returns: The operation results, it is a list of
|
||||
# @GuestMemoryBlockResponse, which is corresponding to the input
|
||||
# `GuestMemoryBlockResponse`, which is corresponding to the input
|
||||
# list.
|
||||
#
|
||||
# Note: it will return an empty list if the @mem-blks list was
|
||||
@ -1258,7 +1258,7 @@
|
||||
#
|
||||
# @err-data: base64-encoded stderr of the process. Note: @out-data
|
||||
# and @err-data are present only if 'capture-output' was specified
|
||||
# for 'guest-exec'. This field will only be populated after the
|
||||
# for `guest-exec`. This field will only be populated after the
|
||||
# process exits.
|
||||
#
|
||||
# @out-truncated: true if stdout was not fully captured due to size
|
||||
@ -1277,10 +1277,10 @@
|
||||
# @guest-exec-status:
|
||||
#
|
||||
# Check status of process associated with PID retrieved via
|
||||
# guest-exec. Reap the process and associated metadata if it has
|
||||
# `guest-exec`. Reap the process and associated metadata if it has
|
||||
# exited.
|
||||
#
|
||||
# @pid: pid returned from guest-exec
|
||||
# @pid: pid returned from `guest-exec`
|
||||
#
|
||||
# Since: 2.5
|
||||
##
|
||||
@ -1301,7 +1301,7 @@
|
||||
##
|
||||
# @GuestExecCaptureOutputMode:
|
||||
#
|
||||
# An enumeration of guest-exec capture modes.
|
||||
# An enumeration of `guest-exec` capture modes.
|
||||
#
|
||||
# @none: do not capture any output
|
||||
#
|
||||
@ -1310,7 +1310,7 @@
|
||||
# @stderr: only capture stderr
|
||||
#
|
||||
# @separated: capture both stdout and stderr, but separated into
|
||||
# GuestExecStatus out-data and err-data, respectively
|
||||
# `GuestExecStatus` out-data and err-data, respectively
|
||||
#
|
||||
# @merged: capture both stdout and stderr, but merge together into
|
||||
# out-data. Not effective on windows guests.
|
||||
@ -1324,10 +1324,10 @@
|
||||
##
|
||||
# @GuestExecCaptureOutput:
|
||||
#
|
||||
# Controls what guest-exec output gets captures.
|
||||
# Controls what `guest-exec` output gets captures.
|
||||
#
|
||||
# @flag: captures both stdout and stderr if true. Equivalent to
|
||||
# GuestExecCaptureOutputMode::all. (since 2.5)
|
||||
# `GuestExecCaptureOutputMode`::all. (since 2.5)
|
||||
#
|
||||
# @mode: capture mode; preferred interface
|
||||
#
|
||||
|
||||
Loading…
Reference in New Issue
Block a user