diff mbox series

[1/2] qapi: Drop "with an explanation" from error descriptions

Message ID 20240911132459.2548063-2-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 
All errors come with an explanation, namely the human-readable error
message in the error response's @desc member.  Drop the redundant
"with an explanation" phrase.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/block-core.json | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

Comments

Eric Blake Sept. 12, 2024, 12:59 p.m. UTC | #1 
On Wed, Sep 11, 2024 at 03:24:58PM GMT, Markus Armbruster wrote:
> All errors come with an explanation, namely the human-readable error
> message in the error response's @desc member.  Drop the redundant
> "with an explanation" phrase.
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qapi/block-core.json | 11 +++++------
>  1 file changed, 5 insertions(+), 6 deletions(-)

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

Patch

diff --git a/qapi/block-core.json b/qapi/block-core.json
index 9f6dd59298..82f59a7758 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -2299,7 +2299,7 @@ 
 #
 # Errors:
 #     - If @node is not a valid block device or node, DeviceNotFound
-#     - If @name is already taken, GenericError with an explanation
+#     - If @name is already taken, GenericError
 #
 # Since: 2.4
 #
@@ -2322,7 +2322,7 @@ 
 #
 # Errors:
 #     - If @node is not a valid block device or node, DeviceNotFound
-#     - If @name is not found, GenericError with an explanation
+#     - If @name is not found, GenericError
 #     - if @name is frozen by an operation, GenericError
 #
 # Since: 2.4
@@ -2346,7 +2346,7 @@ 
 #
 # Errors:
 #     - If @node is not a valid block device, DeviceNotFound
-#     - If @name is not found, GenericError with an explanation
+#     - If @name is not found, GenericError
 #
 # Since: 2.4
 #
@@ -2367,7 +2367,7 @@ 
 #
 # Errors:
 #     - If @node is not a valid block device, DeviceNotFound
-#     - If @name is not found, GenericError with an explanation
+#     - If @name is not found, GenericError
 #
 # Since: 4.0
 #
@@ -2388,7 +2388,7 @@ 
 #
 # Errors:
 #     - If @node is not a valid block device, DeviceNotFound
-#     - If @name is not found, GenericError with an explanation
+#     - If @name is not found, GenericError
 #
 # Since: 4.0
 #
@@ -2462,7 +2462,6 @@ 
 # Errors:
 #     - If @node is not a valid block device, DeviceNotFound
 #     - If @name is not found or if hashing has failed, GenericError
-#       with an explanation
 #
 # Since: 2.10
 ##