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