[Qemu-devel] [PATCH 0/2] jobs: minor doc fixups

[Qemu-devel] [PATCH 0/2] jobs: minor doc fixups

[John Snow]

One is from my manual completion series,
the other is from the recent refactor.

John Snow (2):
  jobs: fix stale wording
  jobs: fix verb references in docs

 qapi/job.json | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

-- 
2.14.3

[Qemu-devel] [PATCH 1/2] jobs: fix stale wording

[John Snow]

During the design for manual completion, we decided not to use the
"manual" property as a shorthand for both auto-dismiss and auto-finalize.

Fix the wording.

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

diff --git a/qapi/job.json b/qapi/job.json
index 17d10037c4..226443594b 100644
--- a/qapi/job.json
+++ b/qapi/job.json
@@ -50,16 +50,17 @@
 #           the last job in a transaction.
 #
 # @pending: The job has finished its work, but has finalization steps that it
-#           needs to make prior to completing. These changes may require
-#           manual intervention by the management process if manual was set
-#           to true. These changes may still fail.
+#           needs to make prior to completing. These changes will require
+#           manual intervention via @job-finalize if auto-finalize was set to
+#           false. These pending changes may still fail.
 #
 # @aborting: The job is in the process of being aborted, and will finish with
 #            an error. The job will afterwards report that it is @concluded.
 #            This status may not be visible to the management process.
 #
-# @concluded: The job has finished all work. If manual was set to true, the job
-#             will remain in the query list until it is dismissed.
+# @concluded: The job has finished all work. If auto-dismiss was set to false,
+#             the job will remain in the query list until it is dismissed via
+#             @job-dismiss.
 #
 # @null: The job is in the process of being dismantled. This state should not
 #        ever be visible externally.
-- 
2.14.3

Re: [Qemu-devel] [PATCH 1/2] jobs: fix stale wording

[Jeff Cody]

On Wed, Jun 06, 2018 at 07:02:56PM -0400, John Snow wrote:
> During the design for manual completion, we decided not to use the
> "manual" property as a shorthand for both auto-dismiss and auto-finalize.
> 
> Fix the wording.
> 
> Signed-off-by: John Snow <jsnow@redhat.com>

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

> ---
>  qapi/job.json | 11 ++++++-----
>  1 file changed, 6 insertions(+), 5 deletions(-)
> 
> diff --git a/qapi/job.json b/qapi/job.json
> index 17d10037c4..226443594b 100644
> --- a/qapi/job.json
> +++ b/qapi/job.json
> @@ -50,16 +50,17 @@
>  #           the last job in a transaction.
>  #
>  # @pending: The job has finished its work, but has finalization steps that it
> -#           needs to make prior to completing. These changes may require
> -#           manual intervention by the management process if manual was set
> -#           to true. These changes may still fail.
> +#           needs to make prior to completing. These changes will require
> +#           manual intervention via @job-finalize if auto-finalize was set to
> +#           false. These pending changes may still fail.
>  #
>  # @aborting: The job is in the process of being aborted, and will finish with
>  #            an error. The job will afterwards report that it is @concluded.
>  #            This status may not be visible to the management process.
>  #
> -# @concluded: The job has finished all work. If manual was set to true, the job
> -#             will remain in the query list until it is dismissed.
> +# @concluded: The job has finished all work. If auto-dismiss was set to false,
> +#             the job will remain in the query list until it is dismissed via
> +#             @job-dismiss.
>  #
>  # @null: The job is in the process of being dismantled. This state should not
>  #        ever be visible externally.
> -- 
> 2.14.3
> 

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

[John Snow]

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

[Jeff Cody]

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
> 

Re: [Qemu-devel] [PATCH 0/2] jobs: minor doc fixups

[Markus Armbruster]

John Snow <jsnow@redhat.com> writes:

> One is from my manual completion series,
> the other is from the recent refactor.

Reviewed-by: Markus Armbruster <armbru@redhat.com>

Re: [Qemu-devel] [Qemu-block] [PATCH 0/2] jobs: minor doc fixups

[Kevin Wolf]

Am 07.06.2018 um 01:02 hat John Snow geschrieben:
> One is from my manual completion series,
> the other is from the recent refactor.

Thanks, applied to the block branch.

Kevin