users/config: Document folder.fsWatcherTimeoutS

syncthing · May 29, 2024 · 42ebe92 · 42ebe92
1 parent a2cf798
commit 42ebe92
Showing 1 changed file with 10 additions and 4 deletions.
diff --git a/users/config.rst b/users/config.rst
@@ -92,7 +92,7 @@ The following shows an example of a default configuration file (IDs will differ)
 .. code-block:: xml
 
     <configuration version="37">
-        <folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
+        <folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">
             <filesystemType>basic</filesystemType>
             <device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" introducedBy="">
                 <encryptionPassword></encryptionPassword>
@@ -198,7 +198,7 @@ The following shows an example of a default configuration file (IDs will differ)
         </options>
         <remoteIgnoredDevice time="2022-01-09T20:02:01Z" id="5SYI2FS-LW6YAXI-JJDYETS-NDBBPIO-256MWBO-XDPXWVG-24QPUM4-PDW4UQU" name="bugger" address="192.168.0.20:22000"></remoteIgnoredDevice>
         <defaults>
-            <folder id="" label="" path="~" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
+            <folder id="" label="" path="~" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">
                 <filesystemType>basic</filesystemType>
                 <device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" introducedBy="">
                     <encryptionPassword></encryptionPassword>
@@ -286,7 +286,7 @@ Folder Element
 
 .. code-block:: xml
 
-    <folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
+    <folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">
         <filesystemType>basic</filesystemType>
         <device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" introducedBy="">
             <encryptionPassword></encryptionPassword>
@@ -387,6 +387,12 @@ element:
     The duration during which changes detected are accumulated, before a scan is
     scheduled (only takes effect if :opt:`fsWatcherEnabled` is set to ``true``).
 
+.. option:: folder.fsWatcherTimeoutS
+
+    The maximum delay before a scan is triggered when a file is continuously
+    changing. If unset or zero a default value is calculated based on
+    :opt:`fsWatcherDelayS`.
+
 .. option:: folder.ignorePerms
 
     If ``true``, files originating from this folder will be announced to remote
@@ -1337,7 +1343,7 @@ Defaults Element
 .. code-block:: xml
 
     <defaults>
-        <folder id="" label="" path="~" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
+        <folder id="" label="" path="~" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">
             <filesystemType>basic</filesystemType>
             <device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" introducedBy="">
                 <encryptionPassword></encryptionPassword>