users/config: Add detailed info on disabling progressUpdateIntervalS

Add information on how to disable progressUpdateIntervalS and also warn the user about the consequences of doing so. Signed-off-by: Tomasz Wilczyński <[email protected]>
syncthing · Jul 30, 2023 · 089fb15 · 089fb15
1 parent dfb3f37
commit 089fb15
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/users/config.rst b/users/config.rst
@@ -1145,7 +1145,9 @@ The ``options`` element contains all other global configuration options.
 .. option:: options.progressUpdateIntervalS
 
     How often in seconds the progress of ongoing downloads is made available to
-    the GUI.
+    the GUI. Set to ``-1`` to disable. Note that when disabled, the detailed
+    sync progress for Out of Sync Items which shows how much of each file has
+    been reused, copied, and downloaded will not work.
 
 .. option:: options.limitBandwidthInLan