John Snow <js...@redhat.com> writes:
> The new qapidoc.py can generate "Returns" statements with type
> information just fine, so we can remove it from the source where it
> doesn't add anything particularly novel or helpful and just repeats the
> type info.
>
> This patch is fairly "gentle" and doesn't aggressively touch other
> "Returns" lines that could be rephrased to omit repeating type
> information; it only removes lines that appear appropriate to wholly
> remove.
>
> To help facilitate auto-generated placement, several doc blocks have a
> "TODO:" line inserted to help the placement algorithm differentiate the
> introductory paragraph(s) from the rest of the documentation.
Just three out of 44, fortunately. I discussed this further in review
of the previous patch.
Three others move, as we'll see below. The commit message could mention
it. We could also do the moves in a separate patch. Let's do commit
message, it's easier. Perhaps:
To help facilitate auto-generated placement, a few doc blocks have a
"TODO:" line inserted to help the placement algorithm differentiate the
introductory paragraph(s) from the rest of the documentation.
The auto-generated returns are in the exact same spot, except for
query-migrationthreads, query-machines, and
x-query-virtio-queue-element. These auto-generation moves to a better
spot.
>
> Signed-off-by: John Snow <js...@redhat.com>
> ---
> qapi/audio.json | 2 --
> qapi/block-core.json | 8 --------
> qapi/char.json | 8 --------
> qapi/cryptodev.json | 2 --
> qapi/machine.json | 22 ----------------------
> qapi/migration.json | 12 ++----------
> qapi/misc-i386.json | 10 ----------
> qapi/misc.json | 7 -------
> qapi/rocker.json | 4 ----
> qapi/run-state.json | 2 --
> qapi/tpm.json | 4 ----
> qapi/ui.json | 8 --------
> qapi/virtio.json | 2 --
> qapi/yank.json | 2 +-
> 14 files changed, 3 insertions(+), 90 deletions(-)
>
> diff --git a/qapi/audio.json b/qapi/audio.json
> index 16de231f6d8..e8c469f3452 100644
> --- a/qapi/audio.json
> +++ b/qapi/audio.json
> @@ -535,8 +535,6 @@
> #
> # Return information about audiodev configuration
> #
> -# Returns: array of @Audiodev
> -#
> # Since: 8.0
> ##
> { 'command': 'query-audiodevs',
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index 1df6644f0de..d64f482d9bd 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -1950,8 +1950,6 @@
> # @flat: Omit the nested data about backing image ("backing-image"
> # key) if true. Default is false (Since 5.0)
> #
> -# Returns: the list of BlockDeviceInfo
> -#
> # Since: 2.0
> #
> # .. qmp-example::
> @@ -2464,9 +2462,6 @@
> #
> # @unstable: This command is meant for debugging.
> #
> -# Returns:
> -# BlockDirtyBitmapSha256
> -#
> # Errors:
> # - If @node is not a valid block device, DeviceNotFound
> # - If @name is not found or if hashing has failed, GenericError
> @@ -6202,9 +6197,6 @@
> #
> # @name: optional the snapshot's name to be deleted
> #
> -# Returns:
> -# SnapshotInfo
> -#
> # Errors:
> # - If @device is not a valid block device, GenericError
> # - If snapshot not found, GenericError
> diff --git a/qapi/char.json b/qapi/char.json
> index df6e325e2e1..c189f629c1c 100644
> --- a/qapi/char.json
> +++ b/qapi/char.json
> @@ -36,8 +36,6 @@
> #
> # Return information about current character devices.
> #
> -# Returns: a list of @ChardevInfo
> -#
> # Since: 0.14
> #
> # .. qmp-example::
> @@ -82,8 +80,6 @@
> #
> # Return information about character device backends.
> #
> -# Returns: a list of @ChardevBackendInfo
> -#
> # Since: 2.0
> #
> # .. qmp-example::
> @@ -772,8 +768,6 @@
> #
> # @backend: backend type and parameters
> #
> -# Returns: ChardevReturn.
> -#
> # Since: 1.4
> #
> # .. qmp-example::
> @@ -812,8 +806,6 @@
> #
> # @backend: new backend type and parameters
> #
> -# Returns: ChardevReturn.
> -#
> # Since: 2.10
> #
> # .. qmp-example::
> diff --git a/qapi/cryptodev.json b/qapi/cryptodev.json
> index b13db264034..b028abf927b 100644
> --- a/qapi/cryptodev.json
> +++ b/qapi/cryptodev.json
> @@ -96,8 +96,6 @@
> #
> # Return information about current crypto devices.
> #
> -# Returns: a list of @QCryptodevInfo
> -#
> # Since: 8.0
> ##
> { 'command': 'query-cryptodev', 'returns': ['QCryptodevInfo']}
> diff --git a/qapi/machine.json b/qapi/machine.json
> index e3e0505a4b4..b2062f21088 100644
> --- a/qapi/machine.json
> +++ b/qapi/machine.json
> @@ -101,8 +101,6 @@
> #
> # Return information about all virtual CPUs.
> #
> -# Returns: list of @CpuInfoFast
> -#
> # Since: 2.12
> #
> # .. qmp-example::
> @@ -218,8 +216,6 @@
> #
> # @unstable: Argument @compat-props is experimental.
> #
> -# Returns: a list of MachineInfo
> -#
> # Since: 1.2
> #
> # .. qmp-example::
> @@ -268,8 +264,6 @@
> #
> # Return information on the current virtual machine.
> #
> -# Returns: CurrentMachineParams
> -#
> # Since: 4.0
> ##
> { 'command': 'query-current-machine', 'returns': 'CurrentMachineParams' }
> @@ -291,8 +285,6 @@
> #
> # Return information about the target for this QEMU
> #
> -# Returns: QemuTargetInfo
> -#
> # Since: 1.2
> ##
> { 'command': 'query-target', 'returns': 'QemuTargetInfo' }
> @@ -316,8 +308,6 @@
> #
> # Query the guest UUID information.
> #
> -# Returns: The @UuidInfo for the guest
> -#
> # Since: 0.14
> #
> # .. qmp-example::
> @@ -469,8 +459,6 @@
> #
> # Return information about KVM acceleration
> #
> -# Returns: @KvmInfo
> -#
> # Since: 0.14
> #
> # .. qmp-example::
> @@ -932,8 +920,6 @@
> #
> # Return information for all memory backends.
> #
> -# Returns: a list of @Memdev.
> -#
> # Since: 2.1
> #
> # .. qmp-example::
> @@ -1049,8 +1035,6 @@
> #
> # TODO: Better documentation; currently there is none.
> #
> -# Returns: a list of HotpluggableCPU objects.
> -#
> # Since: 2.7
> #
> # .. qmp-example::
> @@ -1172,9 +1156,6 @@
> #
> # Return information about the balloon device.
> #
> -# Returns:
> -# @BalloonInfo
> -#
> # Errors:
> # - If the balloon driver is enabled but not functional because
> # the KVM kernel module cannot support it, KVMMissingCap
> @@ -1238,9 +1219,6 @@
> # Return the hv-balloon driver data contained in the last received
> # "STATUS" message from the guest.
> #
> -# Returns:
> -# @HvBalloonInfo
> -#
> # Errors:
> # - If no hv-balloon device is present, guest memory status
> # reporting is not enabled or no guest memory status report
> diff --git a/qapi/migration.json b/qapi/migration.json
> index e8a7d3b2a95..59a213aeb6c 100644
> --- a/qapi/migration.json
> +++ b/qapi/migration.json
> @@ -286,8 +286,6 @@
> # is active there will be another json-object with RAM migration
> # status.
> #
> -# Returns: @MigrationInfo
> -#
> # Since: 0.14
> #
> # .. qmp-example::
> @@ -537,8 +535,6 @@
> #
> # Return information about the current migration capabilities status
> #
> -# Returns: @MigrationCapabilityStatus
> -#
> # Since: 1.2
> #
> # .. qmp-example::
> @@ -1324,8 +1320,6 @@
> #
> # Return information about the current migration parameters
> #
> -# Returns: @MigrationParameters
> -#
> # Since: 2.4
> #
> # .. qmp-example::
> @@ -1906,7 +1900,7 @@
> #
> # Query replication status while the vm is running.
> #
> -# Returns: A @ReplicationStatus object showing the status.
> +# TODO: This line is a hack to separate the example from the body
> #
> # .. qmp-example::
> #
> @@ -1960,7 +1954,7 @@
> #
> # Query COLO status while the vm is running.
> #
> -# Returns: A @COLOStatus object showing the status.
> +# TODO: This line is a hack to separate the example from the body
> #
> # .. qmp-example::
> #
> @@ -2335,8 +2329,6 @@
> #
> # @deprecated: This command is deprecated with no replacement yet.
> #
> -# Returns: @MigrationThreadInfo
> -#
> # Since: 7.2
> ##
> { 'command': 'query-migrationthreads',
> diff --git a/qapi/misc-i386.json b/qapi/misc-i386.json
> index 5fefa0a4840..5b3bf597a2f 100644
> --- a/qapi/misc-i386.json
> +++ b/qapi/misc-i386.json
> @@ -132,8 +132,6 @@
> # @enabled field is set to 'false' and the state of all other fields
> # is unspecified.
> #
> -# Returns: @SevInfo
> -#
> # Since: 2.12
> #
> # .. qmp-example::
> @@ -214,8 +212,6 @@
> #
> # This is only supported on AMD X86 platforms with KVM enabled.
> #
> -# Returns: SevCapability objects.
> -#
> # Errors:
> # - If SEV is not available on the platform, GenericError
> #
> @@ -281,8 +277,6 @@
> # @mnonce: a random 16 bytes value encoded in base64 (it will be
> # included in report)
> #
> -# Returns: SevAttestationReport objects.
> -#
> # Errors:
> # - This will return an error if the attestation report is
> # unavailable, either due to an invalid guest configuration
> @@ -345,8 +339,6 @@
> #
> # Return information about configured SGX capabilities of guest
> #
> -# Returns: @SgxInfo
> -#
> # Since: 6.2
> #
> # .. qmp-example::
> @@ -364,8 +356,6 @@
> #
> # Return information about SGX capabilities of host
> #
> -# Returns: @SgxInfo
> -#
> # Since: 6.2
> #
> # .. qmp-example::
> diff --git a/qapi/misc.json b/qapi/misc.json
> index 4b9e601cfa5..8c98fb569a9 100644
> --- a/qapi/misc.json
> +++ b/qapi/misc.json
> @@ -56,8 +56,6 @@
> #
> # Return the name information of a guest.
> #
> -# Returns: @NameInfo of the guest
> -#
> # Since: 0.14
> #
> # .. qmp-example::
> @@ -332,9 +330,6 @@
> #
> # @opaque: A free-form string that can be used to describe the fd.
> #
> -# Returns:
> -# @AddfdInfo
> -#
> # Errors:
> # - If file descriptor was not received, GenericError
> # - If @fdset-id is a negative value, GenericError
> @@ -415,8 +410,6 @@
> #
> # Return information describing all fd sets.
> #
> -# Returns: A list of @FdsetInfo
> -#
> # Since: 1.2
> #
> # .. note:: The list of fd sets is shared by all monitor connections.
> diff --git a/qapi/rocker.json b/qapi/rocker.json
> index 0c7ef1f77c8..2d2ae3bbafc 100644
> --- a/qapi/rocker.json
> +++ b/qapi/rocker.json
> @@ -28,8 +28,6 @@
> #
> # @name: switch name
> #
> -# Returns: @Rocker information
> -#
> # Since: 2.4
> #
> # .. qmp-example::
> @@ -98,8 +96,6 @@
> #
> # @name: port name
> #
> -# Returns: a list of @RockerPort information
> -#
> # Since: 2.4
> #
> # .. qmp-example::
> diff --git a/qapi/run-state.json b/qapi/run-state.json
> index fd09beb35cb..759f8730059 100644
> --- a/qapi/run-state.json
> +++ b/qapi/run-state.json
> @@ -119,8 +119,6 @@
> #
> # Query the run status of the VM
> #
> -# Returns: @StatusInfo reflecting the VM
> -#
> # Since: 0.14
> #
> # .. qmp-example::
> diff --git a/qapi/tpm.json b/qapi/tpm.json
> index a16a72edb98..f749e6869df 100644
> --- a/qapi/tpm.json
> +++ b/qapi/tpm.json
> @@ -27,8 +27,6 @@
> #
> # Return a list of supported TPM models
> #
> -# Returns: a list of TpmModel
> -#
> # Since: 1.5
> #
> # .. qmp-example::
> @@ -58,8 +56,6 @@
> #
> # Return a list of supported TPM types
> #
> -# Returns: a list of TpmType
> -#
> # Since: 1.5
> #
> # .. qmp-example::
> diff --git a/qapi/ui.json b/qapi/ui.json
> index 514fa159b10..ff52ca5a1ce 100644
> --- a/qapi/ui.json
> +++ b/qapi/ui.json
> @@ -325,8 +325,6 @@
> #
> # Return information about the current SPICE server
> #
> -# Returns: @SpiceInfo
> -#
> # Since: 0.14
> #
> # .. qmp-example::
> @@ -656,8 +654,6 @@
> #
> # Return information about the current VNC server
> #
> -# Returns: @VncInfo
> -#
> # Since: 0.14
> #
> # .. qmp-example::
> @@ -687,8 +683,6 @@
> #
> # Return a list of vnc servers. The list can be empty.
> #
> -# Returns: a list of @VncInfo2
> -#
> # Since: 2.3
> ##
> { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'],
> @@ -1564,8 +1558,6 @@
> #
> # Return information about display configuration
> #
> -# Returns: @DisplayOptions
> -#
> # Since: 3.1
> ##
> { 'command': 'query-display-options',
> diff --git a/qapi/virtio.json b/qapi/virtio.json
> index 73df718a261..28feadcd4bc 100644
> --- a/qapi/virtio.json
> +++ b/qapi/virtio.json
> @@ -847,8 +847,6 @@
> #
> # @unstable: This command is meant for debugging.
> #
> -# Returns: VirtioQueueElement information
> -#
> # Since: 7.2
> #
> # .. qmp-example::
> diff --git a/qapi/yank.json b/qapi/yank.json
> index 30f46c97c98..5f26d6c0149 100644
> --- a/qapi/yank.json
> +++ b/qapi/yank.json
> @@ -102,7 +102,7 @@
> #
> # Query yank instances. See @YankInstance for more information.
> #
> -# Returns: list of @YankInstance
> +# TODO: This line is a hack to separate the example from the body
> #
> # .. qmp-example::
> #
Let's check how generated output changes:
@@ -591,7 +591,7 @@ Command query-status (Since: 0.14)
Query the run status of the VM
Return:
- "StatusInfo" -- "StatusInfo" reflecting the VM
+ "StatusInfo"
Expected loss of redundant description text. Good. Not commenting on
this again.
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -3473,7 +3473,7 @@ Command query-named-block-nodes (Since:
(Since 5.0)
Return:
- "[""BlockDeviceInfo""]" -- the list of BlockDeviceInfo
+ "[""BlockDeviceInfo""]"
Clause 1. If we have arguments, return goes right after them. Good.
Example::
@@ -3919,7 +3919,7 @@ Command x-debug-block-dirty-bitmap-sha25
* **unstable** -- This command is meant for debugging.
Return:
- "BlockDirtyBitmapSha256" -- BlockDirtyBitmapSha256
+ "BlockDirtyBitmapSha256"
Clause 1. If we have arguments, return goes right after them. Good.
Errors:
* If "node" is not a valid block device, DeviceNotFound
@@ -7200,7 +7200,7 @@ Command blockdev-snapshot-delete-interna
name to be deleted
Return:
- "SnapshotInfo" -- SnapshotInfo
+ "SnapshotInfo"
Clause 1. If we have arguments, return goes right after them. Good.
Errors:
* If "device" is not a valid block device, GenericError
@@ -8146,7 +8146,7 @@ Command query-chardev (Since: 0.14)
Return information about current character devices.
Return:
- "[""ChardevInfo""]" -- a list of "ChardevInfo"
+ "[""ChardevInfo""]"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -8183,7 +8183,7 @@ Command query-chardev-backends (Since: 2
Return information about character device backends.
Return:
- "[""ChardevBackendInfo""]" -- a list of "ChardevBackendInfo"
+ "[""ChardevBackendInfo""]"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -8724,7 +8724,7 @@ Command chardev-add (Since: 1.4)
* **backend** ("ChardevBackend") -- backend type and parameters
Return:
- "ChardevReturn" -- ChardevReturn.
+ "ChardevReturn"
Clause 1. If we have arguments, return goes right after them. Good.
Example::
@@ -8759,7 +8759,7 @@ Command chardev-change (Since: 2.10)
parameters
Return:
- "ChardevReturn" -- ChardevReturn.
+ "ChardevReturn"
Clause 1. If we have arguments, return goes right after them. Good.
Example::
@@ -9970,7 +9970,7 @@ Command query-rocker (Since: 2.4)
* **name** ("string") -- switch name
Return:
- "RockerSwitch" -- "Rocker" information
+ "RockerSwitch"
Clause 1. If we have arguments, return goes right after them. Good.
Example::
@@ -10020,7 +10020,7 @@ Command query-rocker-ports (Since: 2.4)
* **name** ("string") -- port name
Return:
- "[""RockerPort""]" -- a list of "RockerPort" information
+ "[""RockerPort""]"
Clause 1. If we have arguments, return goes right after them. Good.
Example::
@@ -10249,7 +10249,7 @@ Command query-tpm-models (Since: 1.5)
Return a list of supported TPM models
Return:
- "[""TpmModel""]" -- a list of TpmModel
+ "[""TpmModel""]"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -10272,7 +10272,7 @@ Command query-tpm-types (Since: 1.5)
Return a list of supported TPM types
Return:
- "[""TpmType""]" -- a list of TpmType
+ "[""TpmType""]"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -10652,7 +10652,7 @@ Command query-spice (Since: 0.14)
Return information about the current SPICE server
Return:
- "SpiceInfo" -- "SpiceInfo"
+ "SpiceInfo"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -10969,7 +10969,7 @@ Command query-vnc (Since: 0.14)
Return information about the current VNC server
Return:
- "VncInfo" -- "VncInfo"
+ "VncInfo"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -10997,7 +10997,7 @@ Command query-vnc-servers (Since: 2.3)
Return a list of vnc servers. The list can be empty.
Return:
- "[""VncInfo2""]" -- a list of "VncInfo2"
+ "[""VncInfo2""]"
Clause 4. Else return goes right after the intro. Good.
Command change-vnc-password (Since: 1.1)
*Availability*: "CONFIG_VNC"
@@ -11924,7 +11924,7 @@ Command query-display-options (Since: 3.
Return information about display configuration
Return:
- "DisplayOptions" -- "DisplayOptions"
+ "DisplayOptions"
Clause 4. Else return goes right after the intro. Good.
Enum DisplayReloadType (Since: 6.0)
@@ -12363,7 +12363,7 @@ Command query-migrate (Since: 0.14)
status.
Return:
- "MigrationInfo" -- "MigrationInfo"
+ "MigrationInfo"
Clause 4. Else return goes right after the intro. Good.
Example: Before the first migration:
@@ -12590,7 +12590,7 @@ Command query-migrate-capabilities (Sinc
Return information about the current migration capabilities status
Return:
- "[""MigrationCapabilityStatus""]" -- "MigrationCapabilityStatus"
+ "[""MigrationCapabilityStatus""]"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -13282,7 +13282,7 @@ Command query-migrate-parameters (Since:
Return information about the current migration parameters
Return:
- "MigrationParameters" -- "MigrationParameters"
+ "MigrationParameters"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -13759,8 +13759,7 @@ Command query-xen-replication-status (Si
Query replication status while the vm is running.
Return:
- "ReplicationStatus" -- A "ReplicationStatus" object showing the
- status.
+ "ReplicationStatus"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -13801,7 +13800,7 @@ Command query-colo-status (Since: 3.1)
Query COLO status while the vm is running.
Return:
- "COLOStatus" -- A "COLOStatus" object showing the status.
+ "COLOStatus"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -14094,13 +14093,13 @@ Command query-migrationthreads (Since: 7
Return information of migration threads
+ Return:
+ "[""MigrationThreadInfo""]"
+
Clause 3. Else if we have features, return goes right before them. The
move is good.
Features:
* **deprecated** -- This command is deprecated with no
replacement yet.
- Return:
- "[""MigrationThreadInfo""]" -- "MigrationThreadInfo"
-
Command snapshot-save (Since: 6.0)
Save a VM snapshot
@@ -16596,7 +16595,7 @@ Command query-cpus-fast (Since: 2.12)
Return information about all virtual CPUs.
Return:
- "[""CpuInfoFast""]" -- list of "CpuInfoFast"
+ "[""CpuInfoFast""]"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -16694,12 +16693,12 @@ Command query-machines (Since: 1.2)
* **compat-props** ("boolean", *optional*) -- if true, also
return compatibility properties. (default: false) (since 9.1)
+ Return:
+ "[""MachineInfo""]"
+
Clause 1. If we have arguments, return goes right after them. The move
is good.
Features:
* **unstable** -- Argument "compat-props" is experimental.
- Return:
- "[""MachineInfo""]" -- a list of MachineInfo
-
Example::
-> { "execute": "query-machines", "arguments": { "compat-props": true
} }
@@ -16736,7 +16735,7 @@ Command query-current-machine (Since: 4.
Return information on the current virtual machine.
Return:
- "CurrentMachineParams" -- CurrentMachineParams
+ "CurrentMachineParams"
Clause 4. Else return goes right after the intro. Good.
Object QemuTargetInfo (Since: 1.2)
@@ -16750,7 +16749,7 @@ Command query-target (Since: 1.2)
Return information about the target for this QEMU
Return:
- "QemuTargetInfo" -- QemuTargetInfo
+ "QemuTargetInfo"
Clause 4. Else return goes right after the intro. Good.
Object UuidInfo (Since: 0.14)
@@ -16769,7 +16768,7 @@ Command query-uuid (Since: 0.14)
Query the guest UUID information.
Return:
- "UuidInfo" -- The "UuidInfo" for the guest
+ "UuidInfo"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -16893,7 +16892,7 @@ Command query-kvm (Since: 0.14)
Return information about KVM acceleration
Return:
- "KvmInfo" -- "KvmInfo"
+ "KvmInfo"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -17267,7 +17266,7 @@ Command query-memdev (Since: 2.1)
Return information for all memory backends.
Return:
- "[""Memdev""]" -- a list of "Memdev".
+ "[""Memdev""]"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -17359,7 +17358,7 @@ Object HotpluggableCPU (Since: 2.7)
Command query-hotpluggable-cpus (Since: 2.7)
Return:
- "[""HotpluggableCPU""]" -- a list of HotpluggableCPU objects.
+ "[""HotpluggableCPU""]"
Clause 4. Else return goes right after the intro. Good.
Example:: For pseries machine type started with "-smp
2,cores=2,maxcpus=4 -cpu POWER8":
@@ -17457,7 +17456,7 @@ Command query-balloon (Since: 0.14)
Return information about the balloon device.
Return:
- "BalloonInfo" -- "BalloonInfo"
+ "BalloonInfo"
Clause 2. Else if we have errors, return goes right before them. Good.
Errors:
* If the balloon driver is enabled but not functional because
@@ -17511,7 +17510,7 @@ Command query-hv-balloon-status-report (
"STATUS" message from the guest.
Return:
- "HvBalloonInfo" -- "HvBalloonInfo"
+ "HvBalloonInfo"
Clause 2. Else if we have errors, return goes right before them. Good.
Errors:
* If no hv-balloon device is present, guest memory status
@@ -18595,7 +18594,7 @@ Command query-yank (Since: 6.0)
Query yank instances. See "YankInstance" for more information.
Return:
- "[""YankInstance""]" -- list of "YankInstance"
+ "[""YankInstance""]"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -18649,7 +18648,7 @@ Command query-name (Since: 0.14)
Return the name information of a guest.
Return:
- "NameInfo" -- "NameInfo" of the guest
+ "NameInfo"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -18885,7 +18884,7 @@ Command add-fd (Since: 1.2)
can be used to describe the fd.
Return:
- "AddfdInfo" -- "AddfdInfo"
+ "AddfdInfo"
Clause 1. If we have arguments, return goes right after them. Good.
Errors:
* If file descriptor was not received, GenericError
@@ -18958,7 +18957,7 @@ Command query-fdsets (Since: 1.2)
Return information describing all fd sets.
Return:
- "[""FdsetInfo""]" -- A list of "FdsetInfo"
+ "[""FdsetInfo""]"
Clause 4. Else return goes right after the intro. Good.
Note:
@@ -19247,7 +19246,7 @@ Command query-sev (Since: 2.12)
is unspecified.
Return:
- "SevInfo" -- "SevInfo"
+ "SevInfo"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -19312,7 +19311,7 @@ Command query-sev-capabilities (Since: 2
This is only supported on AMD X86 platforms with KVM enabled.
Return:
- "SevCapability" -- SevCapability objects.
+ "SevCapability"
Clause 2. Else if we have errors, return goes right before them. Good.
Errors:
* If SEV is not available on the platform, GenericError
@@ -19370,7 +19369,7 @@ Command query-sev-attestation-report (Si
base64 (it will be included in report)
Return:
- "SevAttestationReport" -- SevAttestationReport objects.
+ "SevAttestationReport"
Clause 1. If we have arguments, return goes right after them. Good.
Errors:
* This will return an error if the attestation report is
@@ -19414,7 +19413,7 @@ Command query-sgx (Since: 6.2)
Return information about configured SGX capabilities of guest
Return:
- "SgxInfo" -- "SgxInfo"
+ "SgxInfo"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -19429,7 +19428,7 @@ Command query-sgx-capabilities (Since: 6
Return information about SGX capabilities of host
Return:
- "SgxInfo" -- "SgxInfo"
+ "SgxInfo"
Clause 4. Else return goes right after the intro. Good.
Example::
@@ -19946,7 +19945,7 @@ Command query-audiodevs (Since: 8.0)
Return information about audiodev configuration
Return:
- "[""Audiodev""]" -- array of "Audiodev"
+ "[""Audiodev""]"
Clause 4. Else return goes right after the intro. Good.
ACPI
@@ -21238,12 +21237,12 @@ Command x-query-virtio-queue-element (Si
* **index** ("int", *optional*) -- Index of the element in the
queue (default: head of the queue)
+ Return:
+ "VirtioQueueElement"
+
Clause 1. If we have arguments, return goes right after them. The move
is good.
Features:
* **unstable** -- This command is meant for debugging.
- Return:
- "VirtioQueueElement" -- VirtioQueueElement information
-
Example: Introspect on virtio-net's VirtQueue 0 at index 5:
-> { "execute": "x-query-virtio-queue-element",
@@ -21494,7 +21493,7 @@ Command query-cryptodev (Since: 8.0)
Return information about current crypto devices.
Return:
- "[""QCryptodevInfo""]" -- a list of "QCryptodevInfo"
+ "[""QCryptodevInfo""]"
Clause 4. Else return goes right after the intro. Good.
CXL devices
Placement is all good.
Two more Returns: sections this patch should remove:
# @query-cpu-definitions:
#
# Return a list of supported virtual CPU definitions
#
# Returns: a list of CpuDefinitionInfo
#
# Since: 1.2
##
{ 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
and
##
# @query-gic-capabilities:
#
# It will return a list of `GICCapability` objects that describe its
# capability bits.
#
# On non-ARM targets this command will report an error as the GIC
# technology is not applicable.
#
# Returns: a list of GICCapability objects.
#
# Since: 2.6
#
# .. qmp-example::
#
# -> { "execute": "query-gic-capabilities" }
# <- { "return": [{ "version": 2, "emulated": true, "kernel": false },
# { "version": 3, "emulated": false, "kernel": true } ]
}
##
{ 'command': 'query-gic-capabilities', 'returns': ['GICCapability'] }
Tracked down with
$ git-grep '# Returns:.*`'
with your "[PATCH v2 00/18] QAPI: add cross-references to qapi docs"
applied. Shows lines containing QAPI names, which your series helpfully
puts into `backquotes` for easy grepping.
With these two removed, and the commit message amended to note the
moves:
Reviewed-by: Markus Armbruster <arm...@redhat.com>
