diff --git a/users/config.rst b/users/config.rst index 823f5869..ea6f6631 100644 --- a/users/config.rst +++ b/users/config.rst @@ -493,7 +493,18 @@ The following child elements may exist: .. option:: folder.scanProgressIntervalS The interval in seconds with which scan progress information is sent to the GUI. Setting to ``0`` - will cause Syncthing to use the default value of two. + will cause Syncthing to use the default value of two. Setting a negative value will disable + scan progress information. + Enabling scan progress information will buffer the entire file list in RAM (using approximately 512 bytes per file plus the length of all file names): + this can cause high memory usage and :abbr:`GC (garbage collection)` thrashing on large folders, greatly slowing down scans, + so it is recommended to disable this for folders with a lot of files. + +.. option:: folder.scanProgressFileLimit + + Disable emission of scan progress information if more than the specified number of files + are encountered during the scan, useful to avoid running out of memory while buffering the entire file list + in RAM for folders with a lot of files. + Setting to ``0`` will cause Syncthing to use the default value of ``2048``. .. option:: folder.pullerPauseS