diff mbox series

[2/2] qapi/block-core: Drop drive-backup's "Any other error" documentation

Message ID 20240911132459.2548063-3-armbru@redhat.com (mailing list archive)
State New, archived
Headers show
Series qapi: Remove some error documentation lint | expand

Commit Message

Markus Armbruster Sept. 11, 2024, 1:24 p.m. UTC
We've always been rather lax about documenting errors.  Many "Errors"
sections are obviously not exhaustive.  Only drive-backup is explicit
about this: "Any other error returns a GenericError".

Not useful.  Drop.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/block-core.json | 1 -
 1 file changed, 1 deletion(-)

Comments

Eric Blake Sept. 12, 2024, 12:59 p.m. UTC | #1
On Wed, Sep 11, 2024 at 03:24:59PM GMT, Markus Armbruster wrote:
> We've always been rather lax about documenting errors.  Many "Errors"
> sections are obviously not exhaustive.  Only drive-backup is explicit
> about this: "Any other error returns a GenericError".
> 
> Not useful.  Drop.
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qapi/block-core.json | 1 -
>  1 file changed, 1 deletion(-)

Reviewed-by: Eric Blake <eblake@redhat.com>

> 
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index 82f59a7758..485388be32 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -1853,7 +1853,6 @@
>  #
>  # Errors:
>  #     - If @device does not exist, DeviceNotFound
> -#     - Any other error returns a GenericError.
>  #
>  # Since: 1.3
>  #
> -- 
> 2.46.0
>
diff mbox series

Patch

diff --git a/qapi/block-core.json b/qapi/block-core.json
index 82f59a7758..485388be32 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -1853,7 +1853,6 @@ 
 #
 # Errors:
 #     - If @device does not exist, DeviceNotFound
-#     - Any other error returns a GenericError.
 #
 # Since: 1.3
 #