[#711] Do not set default log level trace in cargo

.cargo/config.toml

@@ -4,7 +4,6 @@ rustdocflags = ["-D", "warnings"]
 [env]
 RUST_TEST_THREADS = "1"
 RUST_BACKTRACE = "1"
-IOX2_LOG_LEVEL = "Trace"
 
 [target.debug]
 rustflags = ["-Z", "sanitizer=address"]

FAQ_ICEORYX_DEVS.md

@@ -1,5 +1,28 @@
 # Frequently Asked Questions - iceoryx Developer Edition
 
+## Set `LogLevel::Trace` as default
+
+During development, a detailed log output is often required. Therefore, the log
+level should default to `LogLevel::Trace`. All iceoryx2 examples use the call
+`set_log_level_from_env_or(LogLevel::Info)` to allow overriding the default.
+
+Users can override the log level in the following ways:
+
+1. **Environment variable**
+   Set the variable in the terminal:
+   ```bash
+   export IOX2_LOG_LEVEL="Trace"
+   ```
+
+2. **Cargo environment configuration**
+   Define `IOX2_LOG_LEVEL` in `$GITROOT$/.cargo/config.toml` or globally in
+   `~/.cargo/config.toml` by adding:
+
+   ```toml
+   [env]
+   IOX2_LOG_LEVEL = "Trace"
+   ```
+
 ## Tests marked with `#[should_panic]` attribute do not panic in release builds
 
 This usually happens when the panic is triggert via a `debug_assert` macro.

doc/release-notes/iceoryx2-unreleased.md

@@ -75,6 +75,8 @@
     [#695](https://github.com/eclipse-iceoryx/iceoryx2/issues/695)
 * Fix Miri issues with MetaVec due to temporary borrow
     [#682](https://github.com/eclipse-iceoryx/iceoryx2/issues/682)
+* Do not set default log level for cargo
+    [#711](https://github.com/eclipse-iceoryx/iceoryx2/issues/711)
 
 ### Refactoring