]> git.ipfire.org Git - thirdparty/qemu.git/commit
qapi: Improve documentation around job state @concluded
authorMarkus Armbruster <armbru@redhat.com>
Tue, 27 May 2025 07:39:16 +0000 (09:39 +0200)
committerMarkus Armbruster <armbru@redhat.com>
Tue, 3 Jun 2025 06:34:57 +0000 (08:34 +0200)
commit8fa2020647041e9f01bc308589bb7fa00355ac9b
tree4c9d62677114a6f9078abece7df722af509b08a6
parentfeeb08c260171e8a15236d20f2978c68aae4f569
qapi: Improve documentation around job state @concluded

We use "the query list" in a few places.  It's not entirely obvious
what that means.  It's actually the output of query-jobs or
query-block-jobs.

Documentation of @auto-dismiss talks about the job disappearing from
the query list when it reaches state @concluded.  This is less than
precise.  The job doesn't merely disappear from the query list, it
disappears, period.

Documentation of JobStatus @concluded explains "the job will remain in
the query list until it is dismissed".  Again less than precise.  It
remains in state @concluded until dismissed.

Rephrase without use of "the query list" for clarity and precision.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20250527073916.1243024-14-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
qapi/block-core.json
qapi/job.json