Bring config knobs in a more sensible order

diff --git a/lagdetect.sh b/lagdetect.sh
index b2de69edb854ea953312676dff2d5600ec8929f0..460c92a5de1957c389053e3a27232a4f98646c16 100755 (executable)
--- a/lagdetect.sh
+++ b/lagdetect.sh
@@ -23,22 +23,27 @@
 # CONFIGURATION - adapt these variables to yor needs
 # These will be docmented once this is finished  - promise ;)
 
+# HINT: You may want to use lagdetect_suggest_config from this distribution to
+# get (hopefully) sensible configration values for FUDGE_MS and PING_PEERS.
+
 FUDGE_MS=20.0 # "fudge" factor in msec that yor PING_PEERS are expected to fluctuate in latency under normal conditions
-THRESHOLD=1.2 # factor relevant in judging current latency compared to avg. - leave it at 1.2
 PING_PEERS='1.1.1.1 8.8.8.8' # space-separated list of peer addresses to ping
-PING_GW_IPV4=no # do not use - broken
-PING_GW_IPV6=no # do not use - broken
-PING_SLOTS_PER_PEER=5 # number of samples per PING_PEER to calculate averages over
-PING_INTERVAL=300 # interval in msec to emit ICMP ECHO towards each PING_PEER
+BW_MIN_RX=4000 # your min. acceptable downstream bandwidth to shape to in Kbps
+BW_MAX_RX=30000 # your max. desired downstream bandwidth to shape to in Kbps
 STATS_RX='/sys/class/net/eth1/statistics/rx_bytes' # downstream bandwidth accounting file for your SQM'd interface
 IFACE_RX='ifb4eth1' # interface to apply downstream SQM to
 STATS_TX='/sys/class/net/eth1/statistics/tx_bytes' # upstream bandwidth accounting file for your SQM'd interface (presently not used)
 IFACE_TX='eth1' # interface to apply upstream SQM to (presently not used)
-BW_MIN_RX=4000 # your min. acceptable downstream bandwidth to shape to in Kbps
-BW_MAX_RX=30000 # your max. desired downstream bandwidth to shape to in Kbps
 TREND_DECISION="eager" # choose either "eager" or "relaxed" - the latter trades additional CPU load for quicker decision making
 OPTIMIZATION_PREFERENCE="latency" # try to optimize for either "latency" (i.e., minimze it) or increased "bandwidth"
 
+# Less commonly changed config knobs
+PING_SLOTS_PER_PEER=5 # number of samples per PING_PEER to calculate averages over
+PING_INTERVAL=300 # interval in msec to emit ICMP ECHO towards each PING_PEER
+THRESHOLD=1.2 # factor relevant in judging current latency compared to avg. - leave it at 1.2
+PING_GW_IPV4=no # do not use - broken
+PING_GW_IPV6=no # do not use - broken
+