From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: stefanha@redhat.com, Eric Blake <eblake@redhat.com>
Subject: [PULL 11/13] qapi: Mention both job-cancel and block-job-cancel in doc comments
Date: Tue, 3 Jun 2025 08:36:42 +0200 [thread overview]
Message-ID: <20250603063644.3953528-12-armbru@redhat.com> (raw)
In-Reply-To: <20250603063644.3953528-1-armbru@redhat.com>
Several doc comments mention block-job-cancel where the more generic
job-cancel would also work. Adjust them to mention both.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20250527073916.1243024-12-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
---
qapi/block-core.json | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 6e5b90d5df..ad6de151c8 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -1894,7 +1894,7 @@
# The status of ongoing drive-backup operations can be checked with
# query-block-jobs where the BlockJobInfo.type field has the value
# 'backup'. The operation can be stopped before it has completed
-# using the block-job-cancel command.
+# using the job-cancel or block-job-cancel command.
#
# Features:
#
@@ -1925,7 +1925,7 @@
# The status of ongoing blockdev-backup operations can be checked with
# query-block-jobs where the BlockJobInfo.type field has the value
# 'backup'. The operation can be stopped before it has completed
-# using the block-job-cancel command.
+# using the job-cancel or block-job-cancel command.
#
# Errors:
# - If @device is not a valid block device, DeviceNotFound
@@ -2788,7 +2788,7 @@
# immediately once streaming has started. The status of ongoing block
# streaming operations can be checked with query-block-jobs. The
# operation can be stopped before it has completed using the
-# block-job-cancel command.
+# job-cancel or block-job-cancel command.
#
# The node that receives the data is called the top image, can be
# located in any part of the chain (but always above the base image;
@@ -3075,8 +3075,8 @@
#
# This command will refuse to operate on any job that has not yet
# reached its terminal state, JOB_STATUS_CONCLUDED. For jobs that
-# make use of the BLOCK_JOB_READY event, block-job-cancel or
-# job-complete will still need to be used as appropriate.
+# make use of the BLOCK_JOB_READY event, job-cancel, block-job-cancel
+# or job-complete will still need to be used as appropriate.
#
# @id: The job identifier.
#
--
2.48.1
next prev parent reply other threads:[~2025-06-03 6:38 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-03 6:36 [PULL 00/13] QAPI patches patches for 2025-06-03 Markus Armbruster
2025-06-03 6:36 ` [PULL 01/13] qapi: Tidy up run-together sentences in doc comments Markus Armbruster
2025-06-03 6:36 ` [PULL 02/13] qapi: Tidy up whitespace " Markus Armbruster
2025-06-03 6:36 ` [PULL 03/13] qapi: Move (since X.Y) to end of description Markus Armbruster
2025-06-03 6:36 ` [PULL 04/13] qapi: Avoid breaking lines within (since X.Y) Markus Armbruster
2025-06-03 6:36 ` [PULL 05/13] qapi: Drop a problematic (Since: 2.11) from query-hotpluggable-cpus Markus Armbruster
2025-06-03 6:36 ` [PULL 06/13] qapi: Correct spelling of QEMU in doc comments Markus Armbruster
2025-06-03 6:36 ` [PULL 07/13] qapi: Fix capitalization " Markus Armbruster
2025-06-03 6:36 ` [PULL 08/13] qapi: Use proper markup instead of CAPS for emphasis " Markus Armbruster
2025-06-03 6:36 ` [PULL 09/13] qapi: Spell JSON null correctly in blockdev-reopen documentation Markus Armbruster
2025-06-03 6:36 ` [PULL 10/13] qapi: Refer to job-FOO instead of deprecated block-job-FOO in docs Markus Armbruster
2025-06-03 6:36 ` Markus Armbruster [this message]
2025-06-03 6:36 ` [PULL 12/13] qapi: Tidy up references to job state CONCLUDED Markus Armbruster
2025-06-03 6:36 ` [PULL 13/13] qapi: Improve documentation around job state @concluded Markus Armbruster
2025-06-03 15:52 ` [PULL 00/13] QAPI patches patches for 2025-06-03 Stefan Hajnoczi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250603063644.3953528-12-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).