diff mbox series

[v2,01/40] blockjob: Update block-job-pause/resume documentation

Message ID 20180518132114.4070-2-kwolf@redhat.com
State New
Headers show
Series Generic background jobs | expand

Commit Message

Kevin Wolf May 18, 2018, 1:20 p.m. UTC
Commit 0ec4dfb8d changed block-job_pause/resume so that they return an
error if they don't do anything because the job is already
paused/running. It forgot to update the documentation, so do that now.

Signed-off-by: Kevin Wolf <kwolf@redhat.com>
---
 qapi/block-core.json | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

Comments

Eric Blake May 18, 2018, 2:20 p.m. UTC | #1
On 05/18/2018 08:20 AM, Kevin Wolf wrote:
> Commit 0ec4dfb8d changed block-job_pause/resume so that they return an
> error if they don't do anything because the job is already
> paused/running. It forgot to update the documentation, so do that now.
> 
> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
> ---
>   qapi/block-core.json | 5 ++---
>   1 file changed, 2 insertions(+), 3 deletions(-)
> 

Reviewed-by: Eric Blake <eblake@redhat.com>
John Snow May 18, 2018, 5:12 p.m. UTC | #2
On 05/18/2018 09:20 AM, Kevin Wolf wrote:
> Commit 0ec4dfb8d changed block-job_pause/resume so that they return an
> error if they don't do anything because the job is already
> paused/running. It forgot to update the documentation, so do that now.
> 
> Signed-off-by: Kevin Wolf <kwolf@redhat.com>

D:

Reviewed-by: John Snow <jsnow@redhat.com>
diff mbox series

Patch

diff --git a/qapi/block-core.json b/qapi/block-core.json
index 55728cb823..d32ec95666 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -2338,8 +2338,7 @@ 
 #
 # This command returns immediately after marking the active background block
 # operation for pausing.  It is an error to call this command if no
-# operation is in progress.  Pausing an already paused job has no cumulative
-# effect; a single block-job-resume command will resume the job.
+# operation is in progress or if the job is already paused.
 #
 # The operation will pause as soon as possible.  No event is emitted when
 # the operation is actually paused.  Cancelling a paused job automatically
@@ -2363,7 +2362,7 @@ 
 #
 # This command returns immediately after resuming a paused background block
 # operation.  It is an error to call this command if no operation is in
-# progress.  Resuming an already running job is not an error.
+# progress or if the job is not paused.
 #
 # This command also clears the error status of the job.
 #