Add some documentation to commandline parameters

davidblum · Apr 14, 2014 · d30ba86 · d30ba86
1 parent 83d6d9f
commit d30ba86
Showing 1 changed file with 8 additions and 3 deletions.
diff --git a/plugins/system/check-disk.rb b/plugins/system/check-disk.rb
@@ -17,15 +17,18 @@
 class CheckDisk < Sensu::Plugin::Check::CLI
 
   option :fstype,
-    :short => '-t TYPE',
+    :short => '-t TYPE[,TYPE]',
+    :description => 'Only check fs type(s)',
     :proc => proc {|a| a.split(',') }
 
   option :ignoretype,
-    :short => '-x TYPE',
+    :short => '-x TYPE[,TYPE]',
+    :description => 'Ignore fs type(s)',
     :proc => proc {|a| a.split(',') }
 
   option :ignoremnt,
-    :short => '-i MNT',
+    :short => '-i MNT[,MNT]',
+    :description => 'Ignore mount point(s)',
     :proc => proc {|a| a.split(',') }
 
   option :ignoreline,
@@ -40,11 +43,13 @@ class CheckDisk < Sensu::Plugin::Check::CLI
 
   option :warn,
     :short => '-w PERCENT',
+    :description => 'Warn if PERCENT or more of disk full',
     :proc => proc {|a| a.to_i },
     :default => 85
 
   option :crit,
     :short => '-c PERCENT',
+    :description => 'Critical if PERCENT or more of disk full',
     :proc => proc {|a| a.to_i },
     :default => 95