From: John Wolfe <jwolfe@vmware.com>
Date: Tue, 22 Dec 2020 20:22:03 +0000 (-0800)
Subject: Corrected a few typos and reworded sentences in tools.conf.
X-Git-Tag: stable-11.3.0~202
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=54d0128fc4ec2f2b256b88ad978b780c696b9c5d;p=thirdparty%2Fopen-vm-tools.git

Corrected a few typos and reworded sentences in tools.conf.

Corrected a few typos, reworded a few sentences, added some
details for quiescing scripts and removed some duplicates.
---

diff --git a/open-vm-tools/tools.conf b/open-vm-tools/tools.conf
index fe08ebe8e..c14ed000c 100644
--- a/open-vm-tools/tools.conf
+++ b/open-vm-tools/tools.conf
@@ -269,54 +269,66 @@
 
 [vmbackup]
 
-# enableSyncDriver is not available for Windows:
+# enableSyncDriver is Linux only.
 #enableSyncDriver=true
 
-# enableVSS is Windows only:
+# enableVSS is Windows only.
 #enableVSS=true
 
+# vss.disableAppQuiescing is Windows only.
+# This setting can be used to force file system quiescing on Windows systems
+# having problems with application quiescing.
 # See https://kb.vmware.com/s/article/2146204
-# can be used to fallback to FS quiescing forcely when there are app quiescing
-# problems for specific Windows systems
 #vss.disableAppQuiescing=false
 
-#execScripts=true
-#scriptArg=
-
 # Linux:
 # The value of excludedFileSystems is a comma-separated list of glob-style
-# patterns specifying the file systems to be excluded from quiesced snapshots.
-# The patterns may use '*' (wildcard) to represent any string of characters
-# and '?" (joker) to represent any single character. Note that the characters
-# represented by these patters, '*' and '?" may include any characters,
-# including '/'
+# patterns specifying the file system mount points to be excluded from
+# quiescing operation. The patterns may use '*' (wildcard) to represent
+# any string of characters and '?' (joker) to represent any single character.
+# The characters represented by the patterns '*' and '?' may include any
+# characters, including '/'.
 #
 # Windows:
 # The value of excludedFileSystems is a comma-separated list of mount points
 # specifying the volumes to be excluded from quiesced snapshots.
 # Each mount point must be a full path separated and ended with "\\".
-# to exclude volumes with drive letter E and mount point F:\mount\, set below
-# excludedFileSystems= E:\\,F:\\mount\\
-# This option only applies when app quiescing doesn't take effect.
+# For example, to exclude volumes with drive letter 'E' or mount point
+# "F:\mount\", use:
+# excludedFileSystems=E:\\,F:\\mount\\
+# This setting is ignored when application quiescing is used.
 
 #excludedFileSystems=
 
-# Whether to execute scripts on quiescing.
-# Scripts are executed from /etc/vmware-tools/backupScripts.d on Linux and
-# %installpath%\backupScripts.d on Windows, and the legacy scripts
-# "c:\windows\pre-freeze-script.bat"
-# "c:\windows\post-thaw-script.bat"
+# execScripts specifies whether to execute scripts as part of the quiescing
+# operation. Scripts are executed from the scripts directory along with the
+# legacy scripts.
 #
-# Linux:
-# "/usr/sbin/pre-freeze-script"
-# "/usr/sbin/post-thaw-script"
+# Scripts directory:
+# Linux: /etc/vmware-tools/backupScripts.d
+# Windows: <Install-Path>\backupScripts.d
+#
+# Legacy scripts:
+# Linux: /usr/sbin/pre-freeze-script and /usr/sbin/post-thaw-script
+# Windows: C:\windows\pre-freeze-script.bat and C:\windows\post-thaw-script.bat
 #
-# Scripts will be called with "freeze", "freezeFail" or "thaw" as their first
-# arguments.
+# On each quiescing operation, scripts are invoked before quiescing and
+# either after a quiescing failure or after thawing.
+# The first argument passed to each script is
+# "freeze", when invoked before quiescing;
+# "freezefail", when invoked after a quiescing failure; or
+# "thaw", when invoked after thawing.
+# When invoked before quiescing, scripts from the directory are invoked in
+# alphabetically ascending order; when invoked following a quiescing failure
+# or thawing, they are invoked in the reverse order. Any subdirectories are
+# ignored.
+# Note that the legacy pre-freeze-script is invoked only before quiescing as
+# the first script and post-thaw-script is invoked after a quiescing failure
+# as well as after thawing as the last script.
 
 #execScripts=true
 
-# additional argument to be passed to scripts
+# Additional argument to be passed to scripts
 #scriptArg=
 
 [guestoperations]