Re: [Qemu-devel] [PATCH v2 09/11] qga: fix guest-get-memory-block-info doc

[Markus Armbruster]

Marc-André Lureau  writes:

> Signed-off-by: Marc-André Lureau 
> ---
>  qga/qapi-schema.json | 1 -
>  1 file changed, 1 deletion(-)
>
> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> index 09c9728..7a35267 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -954,7 +954,6 @@
>  #
>  # Get information relating to guest memory blocks.
>  #
> -# Returns: memory block size in bytes.
>  # Returns: @GuestMemoryBlockInfo
>  #
>  # Since 2.3

This is an instance of the general "doc comment doesn't match the actual
definition" doc bug pattern.

Does your doc generator (which I still haven't reviewed) check doc
comments against the definition?

[Qemu-devel] [PATCH v2 09/11] qga: fix guest-get-memory-block-info doc

[Marc-André Lureau]

Signed-off-by: Marc-André Lureau 
---
 qga/qapi-schema.json | 1 -
 1 file changed, 1 deletion(-)

diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index 09c9728..7a35267 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -954,7 +954,6 @@
 #
 # Get information relating to guest memory blocks.
 #
-# Returns: memory block size in bytes.
 # Returns: @GuestMemoryBlockInfo
 #
 # Since 2.3
-- 
2.10.0