qga: improve fsfreeze documentations

[Qemu-devel] [PATCH] qga: improve fsfreeze documentations

Posted by Marc-André Lureau 7 years ago

Some users find the fsfreeze behaviour confusing. Add some notes about
invalid mount points and Windows usage.

Related to:
https://bugzilla.redhat.com/show_bug.cgi?id=1436976

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---
 qga/qapi-schema.json | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index a02dbf2d18..8d901f556a 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -426,7 +426,13 @@
 ##
 # @guest-fsfreeze-freeze:
 #
-# Sync and freeze all freezable, local guest filesystems
+# Sync and freeze all freezable, local guest filesystems. If this
+# command succeeded, you may call @guest-fsfreeze-thaw later to
+# unfreeze.
+#
+# 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.
@@ -439,10 +445,12 @@
 ##
 # @guest-fsfreeze-freeze-list:
 #
-# Sync and freeze specified guest filesystems
+# Sync and freeze specified guest filesystems.
+# See also @guest-fsfreeze-freeze.
 #
 # @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.
-- 
2.12.0.191.gc5d8de91d

Re: [Qemu-devel] [PATCH] qga: improve fsfreeze documentations

Posted by Vinzenz Feenstra 7 years ago

LGTM 

> On Apr 3, 2017, at 11:54 AM, Marc-André Lureau <marcandre.lureau@redhat.com> wrote:
> 
> Some users find the fsfreeze behaviour confusing. Add some notes about
> invalid mount points and Windows usage.
> 
> Related to:
> https://bugzilla.redhat.com/show_bug.cgi?id=1436976
> 
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> ---
> qga/qapi-schema.json | 12 ++++++++++--
> 1 file changed, 10 insertions(+), 2 deletions(-)
> 
> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> index a02dbf2d18..8d901f556a 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -426,7 +426,13 @@
> ##
> # @guest-fsfreeze-freeze:
> #
> -# Sync and freeze all freezable, local guest filesystems
> +# Sync and freeze all freezable, local guest filesystems. If this
> +# command succeeded, you may call @guest-fsfreeze-thaw later to
> +# unfreeze.
> +#
> +# 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.
> @@ -439,10 +445,12 @@
> ##
> # @guest-fsfreeze-freeze-list:
> #
> -# Sync and freeze specified guest filesystems
> +# Sync and freeze specified guest filesystems.
> +# See also @guest-fsfreeze-freeze.
> #
> # @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.
> -- 
> 2.12.0.191.gc5d8de91d
> 
>

Re: [Qemu-devel] [PATCH] qga: improve fsfreeze documentations

Posted by Vinzenz Feenstra 7 years ago

Reviewed-by: Vinzenz Feenstra <vfeenstr@redhat.com <mailto:marcandre.lureau@redhat.com>>

> On Apr 3, 2017, at 11:54 AM, Marc-André Lureau <marcandre.lureau@redhat.com> wrote:
> 
> Some users find the fsfreeze behaviour confusing. Add some notes about
> invalid mount points and Windows usage.
> 
> Related to:
> https://bugzilla.redhat.com/show_bug.cgi?id=1436976
> 
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> ---
> qga/qapi-schema.json | 12 ++++++++++--
> 1 file changed, 10 insertions(+), 2 deletions(-)
> 
> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> index a02dbf2d18..8d901f556a 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -426,7 +426,13 @@
> ##
> # @guest-fsfreeze-freeze:
> #
> -# Sync and freeze all freezable, local guest filesystems
> +# Sync and freeze all freezable, local guest filesystems. If this
> +# command succeeded, you may call @guest-fsfreeze-thaw later to
> +# unfreeze.
> +#
> +# 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.
> @@ -439,10 +445,12 @@
> ##
> # @guest-fsfreeze-freeze-list:
> #
> -# Sync and freeze specified guest filesystems
> +# Sync and freeze specified guest filesystems.
> +# See also @guest-fsfreeze-freeze.
> #
> # @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.
> -- 
> 2.12.0.191.gc5d8de91d
> 
> 

--
Vinzenz Feenstra
Senior Software Developer
Red Hat Czech

Re: [Qemu-devel] [PATCH] qga: improve fsfreeze documentations

Posted by Michael Roth 7 years ago

Quoting Marc-André Lureau (2017-04-03 04:54:38)
> Some users find the fsfreeze behaviour confusing. Add some notes about
> invalid mount points and Windows usage.
> 
> Related to:
> https://bugzilla.redhat.com/show_bug.cgi?id=1436976
> 
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>

Thanks, applied to qga tree:

  https://github.com/mdroth/qemu/commits/qga

> ---
>  qga/qapi-schema.json | 12 ++++++++++--
>  1 file changed, 10 insertions(+), 2 deletions(-)
> 
> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> index a02dbf2d18..8d901f556a 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -426,7 +426,13 @@
>  ##
>  # @guest-fsfreeze-freeze:
>  #
> -# Sync and freeze all freezable, local guest filesystems
> +# Sync and freeze all freezable, local guest filesystems. If this
> +# command succeeded, you may call @guest-fsfreeze-thaw later to
> +# unfreeze.
> +#
> +# 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.
> @@ -439,10 +445,12 @@
>  ##
>  # @guest-fsfreeze-freeze-list:
>  #
> -# Sync and freeze specified guest filesystems
> +# Sync and freeze specified guest filesystems.
> +# See also @guest-fsfreeze-freeze.
>  #
>  # @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.
> -- 
> 2.12.0.191.gc5d8de91d
>