motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-08-18 15:42:09 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

qapi: Refer to job-FOO instead of deprecated block-job-FOO in docs

Browse source 
We deprecated several block-job-FOO commands in commit
b836bf2ab6 (qapi/block-core: deprecate some block-job- APIs).  Update
the doc comments to refer to their replacements instead.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20250527073916.1243024-11-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
This commit is contained in:
Markus Armbruster 2025-05-27 09:39:13 +02:00
parent 51acba6fad
commit 5ca6400cad
1 changed files with 28 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

57
qapi/block-core.json
View file

@ -1606,16 +1606,16 @@
# copy-before-write jobs; defaults to break-guest-write. (Since 10.1) # copy-before-write jobs; defaults to break-guest-write. (Since 10.1)
# #
# @auto-finalize: When false, this job will wait in a PENDING state # @auto-finalize: When false, this job will wait in a PENDING state
# after it has finished its work, waiting for @block-job-finalize # after it has finished its work, waiting for @job-finalize before
# before making any block graph changes. When true, this job will # making any block graph changes. When true, this job will
# automatically perform its abort or commit actions. Defaults to # automatically perform its abort or commit actions. Defaults to
# true. (Since 2.12) # true. (Since 2.12)
# #
# @auto-dismiss: When false, this job will wait in a CONCLUDED state # @auto-dismiss: When false, this job will wait in a CONCLUDED state
# after it has completely ceased all work, and awaits # after it has completely ceased all work, and awaits
# @block-job-dismiss. When true, this job will automatically # @job-dismiss. When true, this job will automatically disappear
# disappear from the query list without user intervention. # from the query list without user intervention. Defaults to
# Defaults to true. (Since 2.12) # true. (Since 2.12)
# #
# @filter-node-name: the node name that should be assigned to the # @filter-node-name: the node name that should be assigned to the
# filter driver that the backup job inserts into the graph above # filter driver that the backup job inserts into the graph above
@ -1785,8 +1785,7 @@
# If top == base, that is an error. If top has no overlays on top of # If top == base, that is an error. If top has no overlays on top of
# it, or if it is in use by a writer, the job will not be completed by # it, or if it is in use by a writer, the job will not be completed by
# itself. The user needs to complete the job with the # itself. The user needs to complete the job with the
# block-job-complete command after getting the ready event. # job-complete command after getting the ready event. (Since 2.0)
# (Since 2.0)
# #
# If the base image is smaller than top, then the base image will be # If the base image is smaller than top, then the base image will be
# resized to be the same size as top. If top is smaller than the base # resized to be the same size as top. If top is smaller than the base
@ -1848,16 +1847,16 @@
# autogenerated. (Since: 2.9) # autogenerated. (Since: 2.9)
# #
# @auto-finalize: When false, this job will wait in a PENDING state # @auto-finalize: When false, this job will wait in a PENDING state
# after it has finished its work, waiting for @block-job-finalize # after it has finished its work, waiting for @job-finalize before
# before making any block graph changes. When true, this job will # making any block graph changes. When true, this job will
# automatically perform its abort or commit actions. Defaults to # automatically perform its abort or commit actions. Defaults to
# true. (Since 3.1) # true. (Since 3.1)
# #
# @auto-dismiss: When false, this job will wait in a CONCLUDED state # @auto-dismiss: When false, this job will wait in a CONCLUDED state
# after it has completely ceased all work, and awaits # after it has completely ceased all work, and awaits
# @block-job-dismiss. When true, this job will automatically # @job-dismiss. When true, this job will automatically disappear
# disappear from the query list without user intervention. # from the query list without user intervention. Defaults to
# Defaults to true. (Since 3.1) # true. (Since 3.1)
# #
# Features: # Features:
# #
@ -2212,16 +2211,16 @@
# 'background' (Since: 3.0) # 'background' (Since: 3.0)
# #
# @auto-finalize: When false, this job will wait in a PENDING state # @auto-finalize: When false, this job will wait in a PENDING state
# after it has finished its work, waiting for @block-job-finalize # after it has finished its work, waiting for @job-finalize before
# before making any block graph changes. When true, this job will # making any block graph changes. When true, this job will
# automatically perform its abort or commit actions. Defaults to # automatically perform its abort or commit actions. Defaults to
# true. (Since 3.1) # true. (Since 3.1)
# #
# @auto-dismiss: When false, this job will wait in a CONCLUDED state # @auto-dismiss: When false, this job will wait in a CONCLUDED state
# after it has completely ceased all work, and awaits # after it has completely ceased all work, and awaits
# @block-job-dismiss. When true, this job will automatically # @job-dismiss. When true, this job will automatically disappear
# disappear from the query list without user intervention. # from the query list without user intervention. Defaults to
# Defaults to true. (Since 3.1) # true. (Since 3.1)
# #
# Since: 1.3 # Since: 1.3
## ##
@ -2531,16 +2530,16 @@
# 'background' (Since: 3.0) # 'background' (Since: 3.0)
# #
# @auto-finalize: When false, this job will wait in a PENDING state # @auto-finalize: When false, this job will wait in a PENDING state
# after it has finished its work, waiting for @block-job-finalize # after it has finished its work, waiting for @job-finalize before
# before making any block graph changes. When true, this job will # making any block graph changes. When true, this job will
# automatically perform its abort or commit actions. Defaults to # automatically perform its abort or commit actions. Defaults to
# true. (Since 3.1) # true. (Since 3.1)
# #
# @auto-dismiss: When false, this job will wait in a CONCLUDED state # @auto-dismiss: When false, this job will wait in a CONCLUDED state
# after it has completely ceased all work, and awaits # after it has completely ceased all work, and awaits
# @block-job-dismiss. When true, this job will automatically # @job-dismiss. When true, this job will automatically disappear
# disappear from the query list without user intervention. # from the query list without user intervention. Defaults to
# Defaults to true. (Since 3.1) # true. (Since 3.1)
# #
# @target-is-zero: Assume the destination reads as all zeroes before # @target-is-zero: Assume the destination reads as all zeroes before
# the mirror started. Setting this to true can speed up the # the mirror started. Setting this to true can speed up the
@ -2859,16 +2858,16 @@
# autogenerated. (Since: 6.0) # autogenerated. (Since: 6.0)
# #
# @auto-finalize: When false, this job will wait in a PENDING state # @auto-finalize: When false, this job will wait in a PENDING state
# after it has finished its work, waiting for @block-job-finalize # after it has finished its work, waiting for @job-finalize before
# before making any block graph changes. When true, this job will # making any block graph changes. When true, this job will
# automatically perform its abort or commit actions. Defaults to # automatically perform its abort or commit actions. Defaults to
# true. (Since 3.1) # true. (Since 3.1)
# #
# @auto-dismiss: When false, this job will wait in a CONCLUDED state # @auto-dismiss: When false, this job will wait in a CONCLUDED state
# after it has completely ceased all work, and awaits # after it has completely ceased all work, and awaits
# @block-job-dismiss. When true, this job will automatically # @job-dismiss. When true, this job will automatically disappear
# disappear from the query list without user intervention. # from the query list without user intervention. Defaults to
# Defaults to true. (Since 3.1) # true. (Since 3.1)
# #
# Errors: # Errors:
# - If @device does not exist, DeviceNotFound. # - If @device does not exist, DeviceNotFound.
@ -3077,7 +3076,7 @@
# This command will refuse to operate on any job that has not yet # This command will refuse to operate on any job that has not yet
# reached its terminal state, JOB_STATUS_CONCLUDED. For jobs that # reached its terminal state, JOB_STATUS_CONCLUDED. For jobs that
# make use of the BLOCK_JOB_READY event, block-job-cancel or # make use of the BLOCK_JOB_READY event, block-job-cancel or
# block-job-complete will still need to be used as appropriate. # job-complete will still need to be used as appropriate.
# #
# @id: The job identifier. # @id: The job identifier.
# #
@ -5866,7 +5865,7 @@
# @BLOCK_JOB_PENDING: # @BLOCK_JOB_PENDING:
# #
# Emitted when a block job is awaiting explicit authorization to # Emitted when a block job is awaiting explicit authorization to
# finalize graph changes via @block-job-finalize. If this job is part # finalize graph changes via @job-finalize. If this job is part
# of a transaction, it will not emit this event until the transaction # of a transaction, it will not emit this event until the transaction
# has converged first. # has converged first.
# #