diff options
| author | Markus Armbruster <armbru@redhat.com> | 2024-02-05 08:47:03 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2024-02-12 10:04:31 +0100 |
| commit | ca86608f7b0363e6337374bd3f6d47da4f3125d7 (patch) | |
| tree | 0976d2a0a8e5901cdee2573a8e0166cef1f7597f /qga | |
| parent | 0b34cf84e65c4804eeb6f6b724acbaaa07c8df0b (diff) | |
| download | qemu-ca86608f7b0363e6337374bd3f6d47da4f3125d7.zip qemu-ca86608f7b0363e6337374bd3f6d47da4f3125d7.tar.gz qemu-ca86608f7b0363e6337374bd3f6d47da4f3125d7.tar.bz2 | |
qga/qapi-schema: Plug trivial documentation holes
Add missing return member documentation of guest-get-disks,
guest-get-devices, guest-get-diskstats, and guest-get-cpustats.
The NVMe SMART information returned by guest-getdisks remains
undocumented. Add a TODO there.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-10-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Diffstat (limited to 'qga')
| -rw-r--r-- | qga/qapi-schema.json | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json index f3d168d..b8efe31 100644 --- a/qga/qapi-schema.json +++ b/qga/qapi-schema.json @@ -36,12 +36,6 @@ 'guest-sync-delimited' ], # Types and commands with undocumented members: 'documentation-exceptions': [ - 'GuestCpuStats', - 'GuestCpuStatsType', - 'GuestDeviceId', - 'GuestDeviceType', - 'GuestDiskSmart', - 'GuestDiskStatsInfo', 'GuestNVMeSmart' ] } } ## @@ -944,6 +938,8 @@ # NVMe smart information, based on NVMe specification, section # <SMART / Health Information (Log Identifier 02h)> # +# TODO: document members briefly +# # Since: 7.1 ## { 'struct': 'GuestNVMeSmart', @@ -978,7 +974,7 @@ # # Disk type related smart information. # -# - @nvme: NVMe disk smart +# @type: disk bus type # # Since: 7.1 ## @@ -1499,6 +1495,8 @@ ## # @GuestDeviceType: +# +# @pci: PCI device ## { 'enum': 'GuestDeviceType', 'data': [ 'pci' ] } @@ -1518,7 +1516,9 @@ ## # @GuestDeviceId: # -# Id of the device - @pci: PCI ID, since: 5.2 +# Id of the device +# +# @type: device type # # Since: 5.2 ## @@ -1700,6 +1700,8 @@ # @major: major device number of disk # # @minor: minor device number of disk +# +# @stats: I/O statistics ## { 'struct': 'GuestDiskStatsInfo', 'data': {'name': 'str', @@ -1723,7 +1725,9 @@ ## # @GuestCpuStatsType: # -# An enumeration of OS type +# Guest operating systems supporting CPU statistics +# +# @linux: Linux # # Since: 7.1 ## @@ -1780,7 +1784,7 @@ # # Get statistics of each CPU in millisecond. # -# - @linux: Linux style CPU statistics +# @type: guest operating system # # Since: 7.1 ## |