mirrors/qemu
0
0 Fork 0
mirror of https://gitlab.com/qemu-project/qemu.git synced 2026-10-28 14:04:39 +08:00
Code Activity

qapi: convert/split intros for job.json commands

Browse Source 
Convert or split apart the existing intro for commands in job.json
into introduction and details sections. The introduction is indented,
remaining plaintext/details paragraphs are not.

@job-dismiss has its text split apart a little more aggressively to
help the documentation read more smoothly in the rendered version.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20260928192557.509157-5-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
John Snow authored and Markus Armbruster committed 2026-09-30 07:51:00 +02:00
1 parent 6e6c7ed137
commit 39b4f03436
1 file changed
+19 -23
Download Patch File Download Diff File Expand all files Collapse all files
qapi/job.json
+19 -23
View File
@@ -128,8 +128,7 @@
##
# @job-pause:
#
# Pause an active job.
# Pause an active job.
#
# This command returns immediately after marking the active job for
# pausing. Pausing an already paused job is an error.
@@ -148,8 +147,7 @@
##
# @job-resume:
#
# Resume a paused job.
# Resume a paused job.
#
# This command returns immediately after resuming a paused job.
# Resuming an already running job is an error.
@@ -165,10 +163,9 @@
##
# @job-cancel:
#
# Instruct an active background job to cancel at the next opportunity.
# This command returns immediately after marking the active job for
# cancellation.
# Instruct an active background job to cancel at the next
# opportunity. This command returns immediately after marking the
# active job for cancellation.
#
# The job will cancel as soon as possible and then emit a
# `JOB_STATUS_CHANGE` event. Usually, the status will change to
@@ -184,9 +181,9 @@
##
# @job-complete:
#
# Manually trigger completion of an active job in the READY or STANDBY
# state. Completing the job in any other state is an error.
# Manually trigger completion of an active job in the READY or
# STANDBY state. Completing the job in any other state is an
# error.
#
# This is supported only for drive mirroring, where it also switches
# the device to write to the target path only. Note that drive
@@ -211,14 +208,14 @@
##
# @job-dismiss:
# Deletes a job that is in the CONCLUDED state.
#
# Deletes a job that is in the CONCLUDED state. This command only
# needs to be run explicitly for jobs that don't have automatic
# dismiss enabled. In turn, automatic dismiss may be enabled only for
# jobs that have @auto-dismiss option, which are `drive-backup`,
# `blockdev-backup`, `drive-mirror`, `blockdev-mirror`, `block-commit`
# and `block-stream`. @auto-dismiss is enabled by default for these
# jobs.
# This command only needs to be run explicitly for jobs that don't
# have automatic dismiss enabled. In turn, automatic dismiss may be
# enabled only for jobs that have @auto-dismiss option, which are
# `drive-backup`, `blockdev-backup`, `drive-mirror`,
# `blockdev-mirror`, `block-commit` and `block-stream`. @auto-dismiss
# is enabled by default for these jobs.
#
# This command will refuse to operate on any job that has not yet
# reached its terminal state, CONCLUDED. For jobs that make use of
@@ -233,11 +230,10 @@
##
# @job-finalize:
#
# Instructs all jobs in a transaction (or a single job if it is not
# part of any transaction) to finalize any graph changes and do any
# necessary cleanup. This command requires that all involved jobs are
# in the PENDING state.
# Instructs all jobs in a transaction (or a single job if it is
# not part of any transaction) to finalize any graph changes and
# do any necessary cleanup. This command requires that all
# involved jobs are in the PENDING state.
#
# For jobs in a transaction, instructing one job to finalize will
# force ALL jobs in the transaction to finalize, so it is only