Re: [PATCH 09/15] qga/qapi-schema: Plug trivial documentation holes

[Daniel P . Berrangé]

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 <armbru@redhat.com>
> ---
>  qga/qapi-schema.json | 24 ++++++++++++++----------
>  1 file changed, 14 insertions(+), 10 deletions(-)

Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>

> @@ -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.


> @@ -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 !


With regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|