From: Michael Orlitzky <michael@orlitzky.com>
Date: Mon, 27 Jan 2014 19:37:04 +0000 (-0500)
Subject: Document the DEBUG log level.
X-Git-Tag: 0.0.6~4
X-Git-Url: http://gitweb.michael.orlitzky.com/?p=dead%2Fhtsn.git;a=commitdiff_plain;h=97168adc8c0cf7b3bc9c64f1129457e84aef2b28

Document the DEBUG log level.
---

diff --git a/doc/htsnrc.example b/doc/htsnrc.example
index 3a2347c..bb2de46 100644
--- a/doc/htsnrc.example
+++ b/doc/htsnrc.example
@@ -40,9 +40,10 @@
 
 # How verbose should the logs be? Valid levels are,
 #
-#   "INFO", "WARNING", "ERROR"
+#   "DEBUG", "INFO", "WARNING", "ERROR"
 #
-# (there are others, but we don't emit them.)
+# (there are others, but we don't emit them.) The debug output is
+# extremely verbose and will not be written to syslog even if you try.
 #
 # Default: "INFO"
 #
diff --git a/doc/man1/htsn.1 b/doc/man1/htsn.1
index 43858c6..2ccb43c 100644
--- a/doc/man1/htsn.1
+++ b/doc/man1/htsn.1
@@ -77,10 +77,11 @@ will not be auto-rotated; use something like logrotate for that.
 Default: none
 
 .IP \fB\-\-log-level\fR
-How verbose should the logs be? We log notifications at three levels:
-INFO, WARN, and ERROR. Specify the \(dqmost boring\(dq level of
+How verbose should the logs be? We log notifications at four levels:
+DEBUG, INFO, WARN, and ERROR. Specify the \(dqmost boring\(dq level of
 notifications you would like to receive (in all-caps); more
-interesting notifications will be logged as well.
+interesting notifications will be logged as well. The debug output is
+extremely verbose and will not be written to syslog even if you try.
 
 Default: INFO
 
diff --git a/htsn.cabal b/htsn.cabal
index 0ef3b5d..2e33589 100644
--- a/htsn.cabal
+++ b/htsn.cabal
@@ -97,10 +97,11 @@ description:
   \--log-level
   @
   .
-  How verbose should the logs be? We log notifications at three levels:
-  INFO, WARN, and ERROR. Specify the \"most boring\" level of
+  How verbose should the logs be? We log notifications at four levels:
+  DEBUG, INFO, WARN, and ERROR. Specify the \"most boring\" level of
   notifications you would like to receive (in all-caps); more
-  interesting notifications will be logged as well.
+  interesting notifications will be logged as well. The debug output is
+  extremely verbose and will not be written to syslog even if you try.
   .
   Default: INFO
   .