You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
qemu/qapi
Markus Armbruster 8fa2020647 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>
5 days ago
..
acpi.json qapi: Tidy up run-together sentences in doc comments 5 days ago
audio.json qapi: Correct spelling of QEMU in doc comments 5 days ago
authz.json qapi: Reformat doc comments to conform to current conventions 2 years ago
block-core.json qapi: Improve documentation around job state @concluded 5 days ago
block-export.json qapi: Correct spelling of QEMU in doc comments 5 days ago
block.json qapi: Fix capitalization in doc comments 5 days ago
char.json qapi: Correct spelling of QEMU in doc comments 5 days ago
common.json hw/qdev-properties-system: Introduce EndianMode QAPI enum 4 months ago
compat.json qapi: Belatedly update CompatPolicy documentation for unstable 2 years ago
control.json qapi: use imperative style in documentation 1 week ago
crypto.json qapi: Tidy up whitespace in doc comments 5 days ago
cryptodev.json qapi: Fix capitalization in doc comments 5 days ago
cxl.json qapi: Fix capitalization in doc comments 5 days ago
dump.json qapi: Use proper markup instead of CAPS for emphasis in doc comments 5 days ago
ebpf.json qapi/ebpf: Drop temporary 'prefix' 9 months ago
error.json qapi: Reformat doc comments to conform to current conventions 2 years ago
introspect.json qapi: Correct spelling of QEMU in doc comments 5 days ago
job.json qapi: Improve documentation around job state @concluded 5 days ago
machine-common.json qapi/qom: Define cache enumeration and properties for machine 7 months ago
machine-s390x.json qapi: make s390x specific CPU commands unconditionally available 1 week ago
machine.json qapi: Fix capitalization in doc comments 5 days ago
meson.build qapi: make all generated files common 1 week ago
migration.json qapi: Use proper markup instead of CAPS for emphasis in doc comments 5 days ago
misc-arm.json qapi: expose query-gic-capability command unconditionally 1 week ago
misc-i386.json qapi: Fix capitalization in doc comments 5 days ago
misc.json qapi: Use proper markup instead of CAPS for emphasis in doc comments 5 days ago
net.json qapi: Avoid breaking lines within (since X.Y) 5 days ago
opts-visitor.c qapi: Inline and remove QERR_INVALID_PARAMETER definition 1 year ago
pci.json qapi/pci: Supply missing member documentation 8 months ago
pragma.json qapi: Document QCryptodevBackendServiceType 8 months ago
qapi-clone-visitor.c qapi: Move include/qapi/qmp/ to include/qobject/ 4 months ago
qapi-dealloc-visitor.c qapi: Move include/qapi/qmp/ to include/qobject/ 4 months ago
qapi-forward-visitor.c qapi: change 'unsigned special_features' to 'uint64_t features' 4 months ago
qapi-schema.json qapi: make s390x specific CPU commands unconditionally available 1 week ago
qapi-type-helpers.c qapi: New strv_from_str_list() 1 year ago
qapi-util.c qapi: change 'unsigned special_features' to 'uint64_t features' 4 months ago
qapi-visit-core.c qapi: change 'unsigned special_features' to 'uint64_t features' 4 months ago
qdev.json docs: Fix some typos (found by codespell and typos) 2 months ago
qmp-dispatch.c qapi: change 'unsigned special_features' to 'uint64_t features' 4 months ago
qmp-event.c qapi: Move include/qapi/qmp/ to include/qobject/ 4 months ago
qmp-registry.c qapi: change 'unsigned special_features' to 'uint64_t features' 4 months ago
qobject-input-visitor.c qapi: change 'unsigned special_features' to 'uint64_t features' 4 months ago
qobject-output-visitor.c qapi: change 'unsigned special_features' to 'uint64_t features' 4 months ago
qom.json qapi: Tidy up whitespace in doc comments 5 days ago
replay.json qapi: convert "Example" sections without titles 11 months ago
rocker.json qapi/rocker: Tidy up query-rocker-of-dpa-flows example 2 months ago
run-state.json qapi: Fix capitalization in doc comments 5 days ago
sockets.json util/qemu-sockets: Introduce inet socket options controlling TCP keep-alive 2 weeks ago
stats.json qapi: Refill doc comments to conform to conventions 10 months ago
string-input-visitor.c qapi: Move include/qapi/qmp/ to include/qobject/ 4 months ago
string-output-visitor.c string-output-visitor: Fix (pseudo) struct handling 1 year ago
tpm.json qapi: convert "Example" sections without titles 11 months ago
trace-events qapi: Generalize struct member policy checking 4 years ago
trace.h
trace.json qapi: convert "Example" sections without titles 11 months ago
transaction.json qapi: Fix capitalization in doc comments 5 days ago
uefi.json qapi: Correct spelling of QEMU in doc comments 5 days ago
ui.json qapi: Correct spelling of QEMU in doc comments 5 days ago
vfio.json qapi/vfio: Rename VfioMigrationState to Qapi*, and drop prefix 9 months ago
virtio.json qapi: use imperative style in documentation 1 week ago
yank.json qapi: convert "Example" sections without titles 11 months ago