Skip to content

Commit 8c97d14

Browse files
author
Oliver Cervera
authored
Improve documentation of SYNC_WARN_THRESHOLD
Fixes #89 Better explain what SYNC_WARN_THRESHOLD does, including Forced Sync option. This explanation was pretty old, in fact was never updated since I started working on the script.
1 parent 77a3e34 commit 8c97d14

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

script-config.sh

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,13 @@ UP_THRESHOLD=500
7070
# result in an ADD_DEL_THRESHOLD of 0.76 (3800/5000)
7171
ADD_DEL_THRESHOLD=0
7272

73-
# Set number of warnings before we force a sync job. This option comes in handy
74-
# when you cannot be bothered to manually start a sync job when DEL_THRESHOLD
75-
# is breached due to false alarm. Set to 0 to ALWAYS force a sync (i.e. ignore
76-
# the delete threshold above) Set to -1 to NEVER force a sync (i.e. need to
77-
# manual sync if delete threshold is breached).
73+
# Set number of warnings before forcing a sync, or force the sync every time
74+
# ignoring thresholds (Forced Sync). This option comes in handy when you cannot be
75+
# bothered to manually start a sync job when DEL_THRESHOLD or UP_TRESHOLD are
76+
# breached due to false alarm.
77+
# Set to 0 to ALWAYS force a sync (Forced Sync, ignoring the thresholds above)
78+
# Set to -1 to NEVER force a sync, the default behaviour (need to manual sync if
79+
# thresholds are breached).
7880
SYNC_WARN_THRESHOLD=-1
7981

8082
# Set percentage and age, in days, of blocks in array to scrub if it is in sync.

0 commit comments

Comments
 (0)