| Message ID | 20180606230257.9038-2-jsnow@redhat.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
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 >
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.
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(-)