From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org
Subject: [PULL 11/18] qga/qapi-schema: Tweak documentation of fsfreeze commands
Date: Mon, 4 Mar 2024 07:32:29 +0100 [thread overview]
Message-ID: <20240304063236.213955-12-armbru@redhat.com> (raw)
In-Reply-To: <20240304063236.213955-1-armbru@redhat.com>
"Returns:" sections of guest-fsfreeze-freeze and
guest-fsfreeze-freeze-list describe both command behavior and success
response. Move behavior out, so "Returns:" is only about success
response.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240227113921.236097-12-armbru@redhat.com>
---
qga/qapi-schema.json | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index 326d324901..2ea1022092 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -437,15 +437,16 @@
# command succeeded, you may call @guest-fsfreeze-thaw later to
# unfreeze.
#
+# On error, all filesystems will be thawed. If no filesystems are
+# frozen as a result of this call, then @guest-fsfreeze-status will
+# remain "thawed" and calling @guest-fsfreeze-thaw is not necessary.
+#
+# Returns: Number of file systems currently frozen.
+#
# Note: On Windows, the command is implemented with the help of a
# Volume Shadow-copy Service DLL helper. The frozen state is
# limited for up to 10 seconds by VSS.
#
-# Returns: Number of file systems currently frozen. On error, all
-# filesystems will be thawed. If no filesystems are frozen as a
-# result of this call, then @guest-fsfreeze-status will remain
-# "thawed" and calling @guest-fsfreeze-thaw is not necessary.
-#
# Since: 0.15.0
##
{ 'command': 'guest-fsfreeze-freeze',
@@ -457,12 +458,13 @@
# Sync and freeze specified guest filesystems. See also
# @guest-fsfreeze-freeze.
#
+# On error, all filesystems will be thawed.
+#
# @mountpoints: an array of mountpoints of filesystems to be frozen.
# If omitted, every mounted filesystem is frozen. Invalid mount
# points are ignored.
#
-# Returns: Number of file systems currently frozen. On error, all
-# filesystems will be thawed.
+# Returns: Number of file systems currently frozen.
#
# Since: 2.2
##
--
2.44.0
next prev parent reply other threads:[~2024-03-04 6:34 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-04 6:32 [PULL 00/18] QAPI patches patches for 2024-03-04 Markus Armbruster
2024-03-04 6:32 ` [PULL 01/18] qapi: Memorize since & returns sections Markus Armbruster
2024-03-04 6:32 ` [PULL 02/18] qapi: Slightly clearer error message for invalid "Returns" section Markus Armbruster
2024-03-04 6:32 ` [PULL 03/18] qapi: New documentation section tag "Errors" Markus Armbruster
2024-03-04 6:32 ` [PULL 04/18] qapi: Move error documentation to new "Errors" sections Markus Armbruster
2024-03-04 6:32 ` [PULL 05/18] qapi: Delete useless "Returns" sections Markus Armbruster
2024-03-04 6:32 ` [PULL 06/18] qapi: Clean up " Markus Armbruster
2024-03-04 6:32 ` [PULL 07/18] qapi/yank: Tweak @yank's error description for consistency Markus Armbruster
2024-03-04 6:32 ` [PULL 08/18] qga/qapi-schema: Move error documentation to new "Errors" sections Markus Armbruster
2024-03-04 6:32 ` [PULL 09/18] qga/qapi-schema: Delete useless "Returns" sections Markus Armbruster
2024-03-04 6:32 ` [PULL 10/18] qga/qapi-schema: Clean up " Markus Armbruster
2024-03-04 6:32 ` Markus Armbruster [this message]
2024-03-04 6:32 ` [PULL 12/18] qga/qapi-schema: Fix guest-set-memory-blocks documentation Markus Armbruster
2024-03-04 6:32 ` [PULL 13/18] qapi: Reject "Returns" section when command doesn't return anything Markus Armbruster
2024-03-04 6:32 ` [PULL 14/18] docs/devel/writing-monitor-commands: Repair a decade of rot Markus Armbruster
2024-03-04 6:32 ` [PULL 15/18] docs/devel/writing-monitor-commands: Minor improvements Markus Armbruster
2024-03-04 6:32 ` [PULL 16/18] qapi: New QAPI_LIST_LENGTH() Markus Armbruster
2024-03-04 6:32 ` [PULL 17/18] qapi: New strv_from_str_list() Markus Armbruster
2024-03-04 6:32 ` [PULL 18/18] migration: simplify exec migration functions Markus Armbruster
2024-03-05 13:45 ` [PULL 00/18] QAPI patches patches for 2024-03-04 Peter Maydell
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=20240304063236.213955-12-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/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).