From: Michael Orlitzky <michael@orlitzky.com>
Date: Mon, 27 Jan 2014 19:38:10 +0000 (-0500)
Subject: Document the DEBUG log level.
X-Git-Tag: 0.0.4~2
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=df252767d9819aee5ea41fa39bb44bd0a811d801;p=dead%2Fhtsn-import.git

Document the DEBUG log level.
---

diff --git a/doc/htsn-importrc.example b/doc/htsn-importrc.example
index 1142797..0cabf7a 100644
--- a/doc/htsn-importrc.example
+++ b/doc/htsn-importrc.example
@@ -41,9 +41,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-import.1 b/doc/man1/htsn-import.1
index a870cbe..49a6927 100644
--- a/doc/man1/htsn-import.1
+++ b/doc/man1/htsn-import.1
@@ -156,10 +156,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