[Qemu-devel] [PATCH 2/2] jobs: fix verb references in docs

John Snow posted 2 patches 7 years, 8 months ago
[Qemu-devel] [PATCH 2/2] jobs: fix verb references in docs
Posted by John Snow 7 years, 8 months ago
These point to the job versions now, not the blockjob versions which
don't really exist anymore.

Except set-speed, which does. It sticks out like a sore thumb. This
patch doesn't fix that, but it doesn't make it any worse, either.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 qapi/job.json | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/qapi/job.json b/qapi/job.json
index 226443594b..9d074eb8d2 100644
--- a/qapi/job.json
+++ b/qapi/job.json
@@ -76,19 +76,19 @@
 #
 # Represents command verbs that can be applied to a job.
 #
-# @cancel: see @block-job-cancel
+# @cancel: see @job-cancel
 #
-# @pause: see @block-job-pause
+# @pause: see @job-pause
 #
-# @resume: see @block-job-resume
+# @resume: see @job-resume
 #
 # @set-speed: see @block-job-set-speed
 #
-# @complete: see @block-job-complete
+# @complete: see @job-complete
 #
-# @dismiss: see @block-job-dismiss
+# @dismiss: see @job-dismiss
 #
-# @finalize: see @block-job-finalize
+# @finalize: see @job-finalize
 #
 # Since: 2.12
 ##
-- 
2.14.3


Re: [Qemu-devel] [PATCH 2/2] jobs: fix verb references in docs
Posted by Jeff Cody 7 years, 8 months ago
On Wed, Jun 06, 2018 at 07:02:57PM -0400, John Snow wrote:
> These point to the job versions now, not the blockjob versions which
> don't really exist anymore.
> 
> Except set-speed, which does. It sticks out like a sore thumb. This
> patch doesn't fix that, but it doesn't make it any worse, either.
> 
> Signed-off-by: John Snow <jsnow@redhat.com>

Reviewed-by: Jeff Cody <jcody@redhat.com>

> ---
>  qapi/job.json | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/qapi/job.json b/qapi/job.json
> index 226443594b..9d074eb8d2 100644
> --- a/qapi/job.json
> +++ b/qapi/job.json
> @@ -76,19 +76,19 @@
>  #
>  # Represents command verbs that can be applied to a job.
>  #
> -# @cancel: see @block-job-cancel
> +# @cancel: see @job-cancel
>  #
> -# @pause: see @block-job-pause
> +# @pause: see @job-pause
>  #
> -# @resume: see @block-job-resume
> +# @resume: see @job-resume
>  #
>  # @set-speed: see @block-job-set-speed
>  #
> -# @complete: see @block-job-complete
> +# @complete: see @job-complete
>  #
> -# @dismiss: see @block-job-dismiss
> +# @dismiss: see @job-dismiss
>  #
> -# @finalize: see @block-job-finalize
> +# @finalize: see @job-finalize
>  #
>  # Since: 2.12
>  ##
> -- 
> 2.14.3
>