aboutsummaryrefslogtreecommitdiff
path: root/qapi
diff options
context:
space:
mode:
authorKevin Wolf <kwolf@redhat.com>2020-02-14 21:08:06 +0100
committerKevin Wolf <kwolf@redhat.com>2020-02-18 10:53:56 +0100
commit248e3ffb66c27cf95623f965b61b0eb97a607441 (patch)
tree05933130d510345a4ecb4aff54ad7a047da9df07 /qapi
parent5b1405db0fbe4c2600dbaa1a340110a3aecef173 (diff)
qapi: Document meaning of 'ignore' BlockdevOnError for jobs
It is not obvious what 'ignore' actually means for block jobs: It could be continuing the job and returning success in the end despite the error (no block job does this). It could also mean continuing and returning failure in the end (this is what stream does). And it can mean retrying the failed request later (this is what backup, commit and mirror do). This (somewhat inconsistent) behaviour was introduced and described for stream and mirror in commit 32c81a4a6ec. backup and commit were introduced later and use the same model as mirror. Signed-off-by: Kevin Wolf <kwolf@redhat.com> Message-Id: <20200214200812.28180-2-kwolf@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Diffstat (limited to 'qapi')
-rw-r--r--qapi/block-core.json5
1 files changed, 4 insertions, 1 deletions
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 13dad62f44..1c32158d11 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -1164,7 +1164,10 @@
# for jobs, cancel the job
#
# @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
-# or BLOCK_JOB_ERROR)
+# or BLOCK_JOB_ERROR). The backup, mirror and commit block jobs retry
+# the failing request later and may still complete successfully. The
+# stream block job continues to stream and will complete with an
+# error.
#
# @enospc: same as @stop on ENOSPC, same as @report otherwise.
#