Add discussion of configurable logging level features to changelog an…

…d readme
rafalh · Oct 23, 2021 · 87fc1ed · 87fc1ed
1 parent 1db1597
commit 87fc1ed
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -32,6 +32,8 @@ New features:
 * Remove `byteorder` dependency.
 * Bump up minimal Rust compiler version to 1.46.0.
 * Build the crate using the 2018 edition.
+* Add support for compile-time configuration of logging levels via Cargo features. By default, all logging levels are
+  enabled, including "trace" and up.
 
 0.3.4 (2020-07-20)
 ------------------

diff --git a/README.md b/README.md
@@ -19,6 +19,7 @@ Features:
 * FAT12, FAT16, FAT32 compatibility
 * LFN (Long File Names) extension is supported
 * Basic no_std environment support
+* logging configurable at compile time using cargo features
 
 Usage
 -----
@@ -59,6 +60,13 @@ Additional features:
 a memory allocator implementation.
 * `unicode` - use Unicode-compatible case conversion in file names - you may want to have it disabled for lower memory
 footprint
+* `log_level_*` - enable specific logging levels at compile time.
+The options are as follows:
+  * `log_level_error` - enable only error-level logging.
+  * `log_level_warn` - enable warn-level logging and higher.
+  * `log_level_info` - enable info-level logging and higher.
+  * `log_level_debug` - enable debug-level logging and higher.
+  * `log_level_trace` - (default) enable all logging levels, trace and higher.
 
 Note: above features are enabled by default and were designed primarily for `no_std` usage.