[PATCH] scripts/qemu-guest-agent/fsfreeze-hook: improve script description

[PATCH] scripts/qemu-guest-agent/fsfreeze-hook: improve script description

[Fabian Ebner]

With the current wording, users might think that the -F option is not
required as long as the script is placed in the default path[0]. Be
clear that the option is always required.

[0]: https://forum.proxmox.com/threads/82680/post-437608

Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
---

I also tried to improve the surrounding text as it sounded a bit off
to me, but English is not my native language, so hoping that I didn't
actually make it worse.

 scripts/qemu-guest-agent/fsfreeze-hook | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/scripts/qemu-guest-agent/fsfreeze-hook b/scripts/qemu-guest-agent/fsfreeze-hook
index 13aafd4845..df9af05e3b 100755
--- a/scripts/qemu-guest-agent/fsfreeze-hook
+++ b/scripts/qemu-guest-agent/fsfreeze-hook
@@ -1,11 +1,12 @@
 #!/bin/sh
 
 # This script is executed when a guest agent receives fsfreeze-freeze and
-# fsfreeze-thaw command, if it is specified in --fsfreeze-hook (-F)
-# option of qemu-ga or placed in default path (/etc/qemu/fsfreeze-hook).
-# When the agent receives fsfreeze-freeze request, this script is issued with
-# "freeze" argument before the filesystem is frozen. And for fsfreeze-thaw
-# request, it is issued with "thaw" argument after filesystem is thawed.
+# fsfreeze-thaw commands, provided that the --fsfreeze-hook (-F) option of
+# qemu-ga is specified and the script is placed in /etc/qemu/fsfreeze-hook
+# (or the custom path specified together with -F). When the agent receives
+# fsfreeze-freeze requests, this script is called with "freeze" as its argument
+# before the filesystem is frozen. And for fsfreeze-thaw requests, it is called
+# with "thaw" as its argument after the filesystem is thawed.
 
 LOGFILE=/var/log/qga-fsfreeze-hook.log
 FSFREEZE_D=$(dirname -- "$0")/fsfreeze-hook.d
-- 
2.30.2