[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 11/13] qga/qapi-schema: Tweak documentation of fsfreeze commands
From: |
Markus Armbruster |
Subject: |
[PATCH 11/13] qga/qapi-schema: Tweak documentation of fsfreeze commands |
Date: |
Tue, 27 Feb 2024 12:39:19 +0100 |
"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>
---
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.43.0
- [PATCH 03/13] qapi: New documentation section tag "Errors", (continued)
- [PATCH 03/13] qapi: New documentation section tag "Errors", Markus Armbruster, 2024/02/27
- [PATCH 02/13] qapi: Slightly clearer error message for invalid "Returns" section, Markus Armbruster, 2024/02/27
- [PATCH 13/13] qapi: Reject "Returns" section when command doesn't return anything, Markus Armbruster, 2024/02/27
- [PATCH 04/13] qapi: Move error documentation to new "Errors" sections, Markus Armbruster, 2024/02/27
- [PATCH 08/13] qga/qapi-schema: Move error documentation to new "Errors" sections, Markus Armbruster, 2024/02/27
- [PATCH 07/13] qapi/yank: Tweak @yank's error description for consistency, Markus Armbruster, 2024/02/27
- [PATCH 05/13] qapi: Delete useless "Returns" sections, Markus Armbruster, 2024/02/27
- [PATCH 10/13] qga/qapi-schema: Clean up "Returns" sections, Markus Armbruster, 2024/02/27
- [PATCH 12/13] qga/qapi-schema: Fix guest-set-memory-blocks documentation, Markus Armbruster, 2024/02/27
- [PATCH 09/13] qga/qapi-schema: Delete useless "Returns" sections, Markus Armbruster, 2024/02/27
- [PATCH 11/13] qga/qapi-schema: Tweak documentation of fsfreeze commands,
Markus Armbruster <=
- [PATCH 06/13] qapi: Clean up "Returns" sections, Markus Armbruster, 2024/02/27