Subject: [PATCH 00/15] qapi: Improve command response documentation

[PATCH 07/13] qapi/yank: Tweak @yank's error description for consistency

Markus Armbruster posted 13 patches 9 months ago

Download mbox

Maintainers: Markus Armbruster <armbru@redhat.com>, Michael Roth <michael.roth@amd.com>, Kevin Wolf <kwolf@redhat.com>, Hanna Reitz <hreitz@redhat.com>, Eric Blake <eblake@redhat.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, Paolo Bonzini <pbonzini@redhat.com>, Eduardo Habkost <eduardo@habkost.net>, Marcel Apfelbaum <marcel.apfelbaum@gmail.com>, "Philippe Mathieu-Daudé" <philmd@linaro.org>, Yanan Wang <wangyanan55@huawei.com>, Peter Xu <peterx@redhat.com>, Fabiano Rosas <farosas@suse.de>, Jason Wang <jasowang@redhat.com>, "Daniel P. Berrangé" <berrange@redhat.com>, Stefan Berger <stefanb@linux.vnet.ibm.com>, Gerd Hoffmann <kraxel@redhat.com>, Lukas Straub <lukasstraub2@web.de>, Konstantin Kostiuk <kkostiuk@redhat.com>

Expand all Fold all

[PATCH 07/13] qapi/yank: Tweak @yank's error description for consistency

Posted by Markus Armbruster 9 months ago

Phrase it like "If <condition>, <error>", like we do elsewhere.

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

diff --git a/qapi/yank.json b/qapi/yank.json
index fffb39a397..89f2f4d199 100644
--- a/qapi/yank.json
+++ b/qapi/yank.json
@@ -79,7 +79,7 @@
 # @instances: the instances to be yanked
 #
 # Errors:
-#     - @DeviceNotFound error, if any of the YankInstances doesn't exist
+#     - If any of the YankInstances doesn't exist, DeviceNotFound
 #
 # Example:
 #
-- 
2.43.0