Source code comments have become outdated/misleading - fix

diff --git a/sqm_lagthrottle.sh b/sqm_lagthrottle.sh
index b9250773198f2d1b7a43efc674cdf8f1809958a3..de083e6806380fa0c71b484ee8d216a3427a82ce 100755 (executable)
--- a/sqm_lagthrottle.sh
+++ b/sqm_lagthrottle.sh
@@ -15,18 +15,15 @@
 #  You should have received a copy of the GNU General Public License
 #  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-# This file needs to be run with '__lagdetec.awk' in your current working
-# directory. Please take the time to review and set all applicable options
-# below under CONFIGURATION. If you fail to do so, the script will probably do
-# more harm than good. Please be aware that this is work in progress, and the
-# main application logic is implemented in the awk script.
+# This file needs to be run with '__sqm_lagthrottle.awk' in your current
+# working directory. Please take the time to review and set all applicable
+# options below under CONFIGURATION. If you fail to do so, the script will
+# probably do more harm than good. Please be aware that this is work in
+# progress, and the main application logic is implemented in the awk script.
 
-# CONFIGURATION - adapt these variables to yor needs
-# These will be docmented once this is finished  - promise ;)
-
-# HINT: You may want to use sqm_lagthrottle_suggest_config.sh from this
-# distribution to get (hopefully) sensible configration values for FUDGE_MS and
-# PING_PEERS.
+# HINT: You may want to use `sqm_lagthrottle_suggest_config.sh` from this
+# distribution to get (hopefully) sensible configuration values for most of
+# the below settings!
 
 FUDGE_MS=20.0 # "fudge" factor in msec that your PING_PEERS are expected to fluctuate in latency under normal conditions
 PING_PEERS='1.1.1.1 8.8.8.8' # space-separated list of peer addresses to ping
@@ -34,8 +31,8 @@ BW_MIN_RX=4000 # CHANGE THIS - your min. acceptable downstream bandwidth to shap
 BW_MAX_RX=30000 # CHANGE THIS - your max. desired downstream bandwidth to shape to in Kbps
 STATS_RX='/sys/class/net/ifb4eth1/statistics/tx_bytes' # CHANGE THIS - downstream bandwidth accounting file for your SQM'd interface
 IFACE_RX='ifb4eth1' # CHANGE THIS - interface to apply downstream SQM to
-STATS_TX='/sys/class/net/eth1/statistics/tx_bytes' # CHANGE THIS - upstream bandwidth accounting file for your SQM'd interface (presently not used)
-IFACE_TX='eth1' # CHANGE THIS - interface to apply upstream SQM to (presently not used)
+STATS_TX='/sys/class/net/eth1/statistics/tx_bytes' # CHANGE THIS - upstream bandwidth accounting file for your SQM'd interface (presently unused)
+IFACE_TX='eth1' # CHANGE THIS - interface to apply upstream SQM to (presently unused)
 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"