Daniel P. Berrangé <[email protected]> writes:
> On Mon, Feb 05, 2024 at 08:47:03AM +0100, Markus Armbruster wrote:
>> 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 <[email protected]>
>> ---
>> qga/qapi-schema.json | 24 ++++++++++++++----------
>> 1 file changed, 14 insertions(+), 10 deletions(-)
>
> Reviewed-by: Daniel P. Berrangé <[email protected]>
>
>> @@ -978,7 +974,7 @@
>> #
>> # Disk type related smart information.
>> #
>> -# - @nvme: NVMe disk smart
>> +# @type: disk bus type
>> #
>> # Since: 7.1
>> ##
>
> Fun, so not only were the fields that exist not documented,
> but we've documented fields which don't exist.
I think the @nvme line tried to document the branch. Not useful; the
doc generator takes care of that:
GuestDiskSmart (Object)
-----------------------
Disk type related smart information.
* nvme: NVMe disk smart
Members
~~~~~~~
"type": "GuestDiskBusType"
Not documented
--> The members of "GuestNVMeSmart" when "type" is "nvme"
>> @@ -1780,7 +1784,7 @@
>> #
>> # Get statistics of each CPU in millisecond.
>> #
>> -# - @linux: Linux style CPU statistics
>> +# @type: guest operating system
>> #
>> # Since: 7.1
>> ##
>
> And more things which don't exist !
Likewise.
