qapi: use imperative style in documentation

As requested by Markus:
> We prefer imperative mood "Return" over "Returns".

Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>
Message-ID: <20250522190542.588267-14-pierrick.bouvier@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Change several more]
This commit is contained in:
Pierrick Bouvier 2025-05-22 12:05:40 -07:00 committed by Markus Armbruster
parent fdbb616f4d
commit e1a80c3241
12 changed files with 26 additions and 26 deletions

View file

@ -533,7 +533,7 @@
##
# @query-audiodevs:
#
# Returns information about audiodev configuration
# Return information about audiodev configuration
#
# Returns: array of @Audiodev
#

View file

@ -83,7 +83,7 @@
##
# @query-pr-managers:
#
# Returns a list of information about each persistent reservation
# Return a list of information about each persistent reservation
# manager.
#
# Returns: a list of @PRManagerInfo for each persistent reservation

View file

@ -34,7 +34,7 @@
##
# @query-chardev:
#
# Returns information about current character devices.
# Return information about current character devices.
#
# Returns: a list of @ChardevInfo
#
@ -80,7 +80,7 @@
##
# @query-chardev-backends:
#
# Returns information about character device backends.
# Return information about character device backends.
#
# Returns: a list of @ChardevBackendInfo
#

View file

@ -91,7 +91,7 @@
##
# @query-version:
#
# Returns the current version of QEMU.
# Return the current version of QEMU.
#
# Returns: A @VersionInfo object describing the current version of
# QEMU.

View file

@ -94,7 +94,7 @@
##
# @query-cryptodev:
#
# Returns information about current crypto devices.
# Return information about current crypto devices.
#
# Returns: a list of @QCryptodevInfo
#

View file

@ -195,7 +195,7 @@
##
# @query-dump-guest-memory-capability:
#
# Returns the available formats for dump-guest-memory
# Return the available formats for dump-guest-memory
#
# Returns: A @DumpGuestMemoryCapability object listing available
# formats for dump-guest-memory

View file

@ -99,7 +99,7 @@
##
# @query-cpus-fast:
#
# Returns information about all virtual CPUs.
# Return information about all virtual CPUs.
#
# Returns: list of @CpuInfoFast
#
@ -467,7 +467,7 @@
##
# @query-kvm:
#
# Returns information about KVM acceleration
# Return information about KVM acceleration
#
# Returns: @KvmInfo
#
@ -930,7 +930,7 @@
##
# @query-memdev:
#
# Returns information for all memory backends.
# Return information for all memory backends.
#
# Returns: a list of @Memdev.
#
@ -1235,7 +1235,7 @@
##
# @query-hv-balloon-status-report:
#
# Returns the hv-balloon driver data contained in the last received
# Return the hv-balloon driver data contained in the last received
# "STATUS" message from the guest.
#
# Returns:

View file

@ -282,7 +282,7 @@
##
# @query-migrate:
#
# Returns information about current migration process. If migration
# Return information about current migration process. If migration
# is active there will be another json-object with RAM migration
# status.
#
@ -535,7 +535,7 @@
##
# @query-migrate-capabilities:
#
# Returns information about the current migration capabilities status
# Return information about the current migration capabilities status
#
# Returns: @MigrationCapabilityStatus
#
@ -1320,7 +1320,7 @@
##
# @query-migrate-parameters:
#
# Returns information about the current migration parameters
# Return information about the current migration parameters
#
# Returns: @MigrationParameters
#
@ -2294,7 +2294,7 @@
##
# @query-vcpu-dirty-limit:
#
# Returns information about virtual CPU dirty page rate limits, if
# Return information about virtual CPU dirty page rate limits, if
# any.
#
# Since: 7.1
@ -2327,7 +2327,7 @@
##
# @query-migrationthreads:
#
# Returns information of migration threads
# Return information of migration threads
#
# Features:
#

View file

@ -126,7 +126,7 @@
##
# @query-sev:
#
# Returns information about SEV/SEV-ES/SEV-SNP.
# Return information about SEV/SEV-ES/SEV-SNP.
#
# If unavailable due to an incompatible configuration the returned
# @enabled field is set to 'false' and the state of all other fields
@ -343,7 +343,7 @@
##
# @query-sgx:
#
# Returns information about configured SGX capabilities of guest
# Return information about configured SGX capabilities of guest
#
# Returns: @SgxInfo
#
@ -362,7 +362,7 @@
##
# @query-sgx-capabilities:
#
# Returns information about SGX capabilities of host
# Return information about SGX capabilities of host
#
# Returns: @SgxInfo
#

View file

@ -101,7 +101,7 @@
##
# @query-iothreads:
#
# Returns a list of information about each iothread.
# Return a list of information about each iothread.
#
# .. note:: This list excludes the QEMU main loop thread, which is not
# declared using the ``-object iothread`` command-line option. It

View file

@ -323,7 +323,7 @@
##
# @query-spice:
#
# Returns information about the current SPICE server
# Return information about the current SPICE server
#
# Returns: @SpiceInfo
#
@ -654,7 +654,7 @@
##
# @query-vnc:
#
# Returns information about the current VNC server
# Return information about the current VNC server
#
# Returns: @VncInfo
#
@ -685,7 +685,7 @@
##
# @query-vnc-servers:
#
# Returns a list of vnc servers. The list can be empty.
# Return a list of vnc servers. The list can be empty.
#
# Returns: a list of @VncInfo2
#
@ -820,7 +820,7 @@
##
# @query-mice:
#
# Returns information about each active mouse device
# Return information about each active mouse device
#
# Returns: a list of @MouseInfo for each device
#
@ -1562,7 +1562,7 @@
##
# @query-display-options:
#
# Returns information about display configuration
# Return information about display configuration
#
# Returns: @DisplayOptions
#

View file

@ -24,7 +24,7 @@
##
# @x-query-virtio:
#
# Returns a list of all realized VirtIODevices
# Return a list of all realized VirtIODevices
#
# Features:
#