sensors.conf.5: Enhance the hysteresis documentation

Mention all supported temperature hysteresis attributes. Recommend
setting each limit before its hysteresis.


git-svn-id: http://lm-sensors.org/svn/lm-sensors/trunk@6246 7894878c-1315-0410-8ee3-d5d059ff63e0

3 files changed, 20 insertions, 12 deletions

diff --git a/CHANGES b/CHANGES
index e94f44f5..240ba9fb 100644
--- a/CHANGES
+++ b/CHANGES
@@ -2,6 +2,7 @@ lm-sensors CHANGES file
 -----------------------
 
 SVN HEAD
+  sensors.conf.5: Enhance the hysteresis documentation
   sensors.conf.default: Add support for NCT6779 and NCT6791
   libsensors: Get rid of arbitrary limit on per-type sensor count
               Add support for temperature min and critical min hysteresis
diff --git a/etc/sensors.conf.eg b/etc/sensors.conf.eg
index d8fc9fc8..309aad6d 100644
--- a/etc/sensors.conf.eg
+++ b/etc/sensors.conf.eg
@@ -745,10 +745,10 @@ chip "lm80-*"
 # All 4 of these limits apply to the single temperature sensor.
 # "crit" may or may not do anything on your motherboard but it should
 #  be set higher than the "max" thresholds.
-#    set temp1_max_hyst   45
 #    set temp1_max        52
-#    set temp1_crit_hyst  57
+#    set temp1_max_hyst   45
 #    set temp1_crit       62
+#    set temp1_crit_hyst  57
 
 
 chip "via686a-*"
@@ -822,12 +822,12 @@ chip "via686a-*"
 # we would still get some oscillation when the temp hovers around the limit
 # due to noise.)
 
-#    set temp1_max_hyst 40
 #    set temp1_max      45
-#    set temp2_max_hyst 55
+#    set temp1_max_hyst 40
 #    set temp2_max      60
-#    set temp3_max_hyst 60
+#    set temp2_max_hyst 55
 #    set temp3_max      65
+#    set temp3_max_hyst 60
 
 # You could set your fan limits too, but the defaults should be fine.
 
@@ -1452,14 +1452,14 @@ chip "vt1211-*"
     compute temp7  1 / (1 / 298.15 - (` (2.2 / @ - 1)) / 3435) - 273.15, \
                    2.2 / (1 + (^ (3435 / 298.15 - 3435 / (273.15 + @))))
 
-#    set temp1_max_hyst 80
 #    set temp1_max      85
-#    set temp2_max_hyst 60
+#    set temp1_max_hyst 80
 #    set temp2_max      65
-#    set temp3_max_hyst 60
+#    set temp2_max_hyst 60
 #    set temp3_max      65
-#    set temp4_max_hyst 40
+#    set temp3_max_hyst 60
 #    set temp4_max      45
+#    set temp4_max_hyst 40
 
 #    set fan1_min 3000
 #    set fan2_min 3000
@@ -1520,10 +1520,10 @@ chip "vt8231-*"
     compute temp3  1 / (1 / 298.15 - (` (2.2 / @ - 1)) / 3435) - 273.15, \
                    2.2 / (1 + (^ (3435 / 298.15 - 3435 / (273.15 + @))))
 
-#    set temp1_max_hyst 60
 #    set temp1_max      65
-#    set temp2_max_hyst 40
+#    set temp1_max_hyst 60
 #    set temp2_max      45
+#    set temp2_max_hyst 40
 
 #    set fan1_min 3000
 #    set fan2_min 3000
diff --git a/lib/sensors.conf.5 b/lib/sensors.conf.5
index e451ed0f..dbf1ba21 100644
--- a/lib/sensors.conf.5
+++ b/lib/sensors.conf.5
@@ -356,7 +356,7 @@ statements are needed.
 
 On top of the usual features, temperatures can have two specific
 sub\-features: temperature sensor type (tempX_type) and hysteresis
-values (tempX_max_hyst and tempX_crit_hyst).
+values (tempX_max_hyst, tempX_crit_hyst etc.).
 
 .SS THERMAL SENSOR TYPES
 
@@ -407,6 +407,8 @@ again immediately.
 
 So, in addition to tempX_max, many chips have a tempX_max_hyst
 sub-feature. Likewise, tempX_crit often comes with tempX_crit_hyst.
+tempX_emerg_hyst, tempX_min_hyst and tempX_lcrit_hyst exist too but
+aren't as common.
 Example:
 
 .RS
@@ -419,6 +421,11 @@ set temp1_max_hyst 56
 The hysteresis mechanism can be disabled by giving both limits the same
 value.
 
+Note that it is strongly recommended to set the hysteresis value after
+the limit value it relates to in the configuration file. Implementation
+details on the hardware or driver side may cause unexpected results if
+the hysteresis value is set first.
+
 .SH BEEPS
 
 Some chips support alarms with beep warnings. When an alarm is triggered