qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org, Eric Blake <eblake@redhat.com>
Subject: [PULL 09/10] qapi: Drop "with an explanation" from error descriptions
Date: Wed,  2 Oct 2024 09:44:03 +0200	[thread overview]
Message-ID: <20241002074404.1983368-10-armbru@redhat.com> (raw)
In-Reply-To: <20241002074404.1983368-1-armbru@redhat.com>

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>
Message-ID: <20240911132459.2548063-2-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
---
 qapi/block-core.json | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/qapi/block-core.json b/qapi/block-core.json
index c3b0a2376b..d3f076db9d 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -2304,7 +2304,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
 #
@@ -2327,7 +2327,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
@@ -2351,7 +2351,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
 #
@@ -2372,7 +2372,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
 #
@@ -2393,7 +2393,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
 #
@@ -2467,7 +2467,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
 ##
-- 
2.46.0




  parent reply	other threads:[~2024-10-02  8:17 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-02  7:43 [PULL 00/10] QAPI patches patches for 2024-10-02 Markus Armbruster
2024-10-02  7:43 ` [PULL 01/10] qapi/char: Supply missing member documentation Markus Armbruster
2024-10-02  7:43 ` [PULL 02/10] qapi/common: " Markus Armbruster
2024-10-02  7:43 ` [PULL 03/10] qapi/crypto: " Markus Armbruster
2024-10-02  7:43 ` [PULL 04/10] qapi/introspect: " Markus Armbruster
2024-10-02  7:43 ` [PULL 05/10] qapi/pci: " Markus Armbruster
2024-10-02  7:44 ` [PULL 06/10] qapi/rocker: " Markus Armbruster
2024-10-02  7:44 ` [PULL 07/10] qapi/cxl: " Markus Armbruster
2024-10-02  7:44 ` [PULL 08/10] qapi: Document QCryptodevBackendServiceType Markus Armbruster
2024-10-02  7:44 ` Markus Armbruster [this message]
2024-10-02  7:44 ` [PULL 10/10] qapi/block-core: Drop drive-backup's "Any other error" documentation Markus Armbruster
2024-10-03 12:01 ` [PULL 00/10] QAPI patches patches for 2024-10-02 Peter Maydell

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241002074404.1983368-10-armbru@redhat.com \
    --to=armbru@redhat.com \
    --cc=eblake@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).