summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2018-06-19 21:07:17 -0300
committerMatthias Beyer <mail@beyermatthias.de>2018-06-23 21:56:02 +0200
commitc86e4e7db4d933d524f9ab32161663f04566e148 (patch)
tree2776ad6b66a618a5e3cb41bdd7dff34302f723c6
parent6ba87a58d18c5ee3b9e3e54b77c97f9cf1675c53 (diff)
downloadimag-c86e4e7db4d933d524f9ab32161663f04566e148.zip
imag-c86e4e7db4d933d524f9ab32161663f04566e148.tar.gz
Add documentation for Runtime::init_logger()
-rw-r--r--lib/core/libimagrt/src/runtime.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/lib/core/libimagrt/src/runtime.rs b/lib/core/libimagrt/src/runtime.rs
index ed1bdc7..4e72404 100644
--- a/lib/core/libimagrt/src/runtime.rs
+++ b/lib/core/libimagrt/src/runtime.rs
@@ -319,6 +319,12 @@ impl<'a> Runtime<'a> {
}
/// Initialize the internal logger
+ ///
+ /// If the environment variable "IMAG_LOG_ENV" is set, this simply
+ /// initializes a env-logger instance. Errors are ignored in this case.
+ /// If the environment variable is not set, this initializes the internal imag logger. On
+ /// error, this exits (as there is nothing we can do about that)
+ ///
fn init_logger(matches: &ArgMatches, config: Option<&Value>) {
use log::set_max_level;
use log::set_boxed_logger;