Upgrade to defmt-decoder v0.4.0 (#2809)

Co-authored-by: Jonathan Pallant <jonathan.pallant@ferrous-systems.com>
probe-rs · Nov 28, 2024 · 849498d · 849498d
1 parent 0d8b011
commit 849498d
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 16 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/changelog/changed-defmt-decoder-v0.4.0.md b/changelog/changed-defmt-decoder-v0.4.0.md
@@ -0,0 +1 @@
+* Upgrade `defmt-decoder` to `v0.4.0`
diff --git a/probe-rs-tools/Cargo.toml b/probe-rs-tools/Cargo.toml
@@ -38,9 +38,7 @@ capstone = "0.12"
 cargo_metadata = "0.19"
 clap = { version = "4", features = ["derive", "env"] }
 colored = "2"
-defmt-decoder = { version = "=0.3.11", features = [
-    "unstable",
-] } # pinned because "unstable" has potential for breaking changes
+defmt-decoder = "0.4"
 directories = "5"
 dunce = "1"
 figment = { version = "0.10", features = ["toml", "json", "yaml", "env"] }

diff --git a/probe-rs-tools/src/bin/probe-rs/cmd/run/mod.rs b/probe-rs-tools/src/bin/probe-rs/cmd/run/mod.rs
@@ -78,7 +78,9 @@ pub struct SharedOptions {
     #[clap(flatten)]
     pub(crate) format_options: FormatOptions,
 
-    /// The default format string to use for decoding defmt logs.
+    /// The format string to use when printing defmt encoded log messages from the target.
+    ///
+    /// See https://defmt.ferrous-systems.com/custom-log-output
     #[clap(long)]
     pub(crate) log_format: Option<String>,
 

diff --git a/probe-rs-tools/src/bin/probe-rs/util/rtt.rs b/probe-rs-tools/src/bin/probe-rs/util/rtt.rs
@@ -308,14 +308,17 @@ impl RttActiveUpChannel {
                 };
 
                 // Format options:
-                // 1. Custom format for the channel
-                // 2. Default with optional timestamp and location
-                let format = if let Some(format) = channel_config.log_format.as_deref() {
-                    FormatterFormat::Custom(format)
-                } else {
-                    FormatterFormat::Default {
+                // 1. Oneline format with optional location
+                // 2. Custom format for the channel
+                // 3. Default with optional location
+                let format = match channel_config.log_format.as_deref() {
+                    Some("oneline") => FormatterFormat::OneLine {
                         with_location: channel_config.show_location,
-                    }
+                    },
+                    Some(format) => FormatterFormat::Custom(format),
+                    None => FormatterFormat::Default {
+                        with_location: channel_config.show_location,
+                    },
                 };
 
                 ChannelDataFormat::Defmt {