aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/lib.rs3
-rw-r--r--src/util.rs19
2 files changed, 12 insertions, 10 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 46549c6..1cfb7fd 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -167,7 +167,8 @@ pub fn set_debug(state: bool) {
}
/// Sets the log level for libnitrokey. All log messages are written to the
-/// standard output or standard errror.
+/// standard error stream. Setting the log level enables all log messages on
+/// the same or on a higher log level.
pub fn set_log_level(level: LogLevel) {
unsafe {
nitrokey_sys::NK_set_debug_level(level.into());
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,
}