Skip to content

Commit de77a98

Browse files
authored
users/config: Document folder.fsWatcherTimeoutS (syncthing#867)
1 parent a2cf798 commit de77a98

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

users/config.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ The following shows an example of a default configuration file (IDs will differ)
9292
.. code-block:: xml
9393
9494
<configuration version="37">
95-
<folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
95+
<folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">
9696
<filesystemType>basic</filesystemType>
9797
<device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" introducedBy="">
9898
<encryptionPassword></encryptionPassword>
@@ -198,7 +198,7 @@ The following shows an example of a default configuration file (IDs will differ)
198198
</options>
199199
<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>
200200
<defaults>
201-
<folder id="" label="" path="~" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
201+
<folder id="" label="" path="~" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">
202202
<filesystemType>basic</filesystemType>
203203
<device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" introducedBy="">
204204
<encryptionPassword></encryptionPassword>
@@ -286,7 +286,7 @@ Folder Element
286286

287287
.. code-block:: xml
288288
289-
<folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
289+
<folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">
290290
<filesystemType>basic</filesystemType>
291291
<device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" introducedBy="">
292292
<encryptionPassword></encryptionPassword>
@@ -387,6 +387,12 @@ element:
387387
The duration during which changes detected are accumulated, before a scan is
388388
scheduled (only takes effect if :opt:`fsWatcherEnabled` is set to ``true``).
389389

390+
.. option:: folder.fsWatcherTimeoutS
391+
392+
The maximum delay before a scan is triggered when a file is continuously
393+
changing. If unset or zero a default value is calculated based on
394+
:opt:`fsWatcherDelayS`.
395+
390396
.. option:: folder.ignorePerms
391397

392398
If ``true``, files originating from this folder will be announced to remote
@@ -1337,7 +1343,7 @@ Defaults Element
13371343
.. code-block:: xml
13381344
13391345
<defaults>
1340-
<folder id="" label="" path="~" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
1346+
<folder id="" label="" path="~" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">
13411347
<filesystemType>basic</filesystemType>
13421348
<device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" introducedBy="">
13431349
<encryptionPassword></encryptionPassword>

0 commit comments

Comments
 (0)