summaryrefslogtreecommitdiff
path: root/src/util.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/util.rs')
-rw-r--r--src/util.rs19
1 files changed, 10 insertions, 9 deletions
diff --git a/src/util.rs b/src/util.rs
index 8a6c411..d380de4 100644
--- a/src/util.rs
+++ b/src/util.rs
@@ -48,22 +48,23 @@ pub enum CommandStatus {
Error(CommandError),
}
-/// Log level for libnitrokey.
+/// Log level for libnitrokey. Setting the log level to a lower level enables
+/// all output from higher levels too. Currently, only the log levels `Warning`,
+/// `DebugL1`, `Debug` and `DebugL2` are actually used.
#[derive(Debug, PartialEq)]
pub enum LogLevel {
- /// Only log error messages.
+ /// Error messages. Currently not used.
Error,
- /// Log error messages and warnings.
+ /// Warning messages.
Warning,
- /// Log error messages, warnings and info messages.
+ /// Informational messages. Currently not used.
Info,
- /// Log error messages, warnings, info messages and debug messages.
+ /// Basic debug messages, especially basic information on the sent and received packets.
DebugL1,
- /// Log error messages, warnings, info messages and detailed debug
- /// messages.
+ /// Detailed debug messages, especially detailed information on the sent and received packets.
Debug,
- /// Log error messages, warnings, info messages and very detailed debug
- /// messages.
+ /// Very detailed debug messages, especially detailed information about the control flow for
+ /// device communication (for example function entries and exits).
DebugL2,
}