Просмотр исходного кода

Added additional documentation to the check_range function

Marc Huffnagle 13 лет назад
Родитель
Сommit
0656a0e284
1 измененных файлов с 10 добавлено и 1 удалено
  1. 10 1
      plugins-scripts/utils.sh.in

+ 10 - 1
plugins-scripts/utils.sh.in

@@ -23,7 +23,16 @@ support() {
 
 
 #
 #
 # check_range takes a value and a range string, returning successfully if an
 # check_range takes a value and a range string, returning successfully if an
-# alert should be raised based on the range.
+# alert should be raised based on the range.  Range values are inclusive.
+# Values may be integers or floats.
+#
+# Example usage:
+#
+# Generating an exit code of 1:
+# check_range 5 2:8
+#
+# Generating an exit code of 0:
+# check_range 1 2:8
 #
 #
 check_range() {
 check_range() {
 	local v range yes no err decimal start end cmp match
 	local v range yes no err decimal start end cmp match