Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Unreleased

[#]

[v0.2.5] - 2021-08-02

#244 Fix clippy warnings
#240 Link Knurling User Survey in README
#235 Update to probe-rs 0.11
#234 Feature-gate windows tests
#233 Some clarifications and corrections

v0.2.4 - 2021-06-17

#212 make unwind::target() infallible
#216 Fix EXC_RETURN detection on thumbv8
#218 add first, user-triggered snapshot tests
#219 add more explicit hint if elf path doesn't lead to an existing file
#221 Obtain git-version from macro, instead of custom build-script
#222 refactor the huge "main" function into smaller functions + modules
#224 target_info: print ram region again
#225 cli::tests: rstest-ify tests for fn extract_git_hash
#226 CI: Run tests and clippy
#228 Remove unused file utils.rs

v0.2.3 - 2021-05-21

Improvements

#193 Check PROBE_RUN_IGNORE_VERSION on runtime
#199 Add column info to backtrace
#200 Highlight frames that point to local code in backtrace
#203 + #209 + #210 Add --shorten-paths
#204 Make 'stopped due to signal' force a backtrace
#207 Read as little stacked registers as possible during unwinding

Docs

#190 README: Replace ${PROBE_RUN_CHIP} in code example
#192 + #194 README: Add installation instructions for Fedora and Ubuntu

Fixes

#206 Fix unwinding exceptions that push FPU registers onto the stack

Internal improvements

#197 Refactor "print backtrace" code
#211 mv backtrace.rs backtrace/mod.rs

v0.2.2 - 2021-05-06

Improvements

#163 Report exit reason, make backtrace optional
#171 Introduce even more verbose log level
#174 Let developers skip defmt version check
#179 Limit backtrace length, make limit configurable
#184 Add some bounds checking to unwinding

Docs

#161 Remind the user that the bench profile should be also overridden
#181 README: add copypasteable example how to run from repo
#183 README: Add troubleshooting for use with RTIC

Fixes

#162 Remove panic-probe

Internal Improvements

#165 Various simplifications
#175 Run cargo fmt -- --check in CI

v0.2.1 - 2021-02-23

#158 Fix Ctrl+C handling

v0.2.0 - 2021-02-22

New Features

#153 Update to defmt 0.2.0
#152 Allow selecting a probe by serial number
#149 Update and deduplicate dependencies

Fixes

#141 Address Clippy lints

v0.1.9 - 2021-01-21

Added

#126 print a list of probes when multiple probes are found and none was selected
#133 removes supported defmt version: c4461eb1484... from -h / --help output

Fixed

#129 reject use of defmt logs and the --no-flash flag.
#132 Make use of the new defmt-logger crate
#134 updates probe-run's defmt dependencies in order to make new features accessible

v0.1.8 - 2020-12-11

Added

#119 probe-run has gained a --connect-under-reset command line flag. When used, the probe drives the NRST pin of the microcontroller to put it in reset state before establishing a SWD / JTAG connection with the device.

Fixed

#117 wait for breakpoint before switching RTT from non-blocking mode to blocking mode.

v0.1.7 - 2020-11-26

Fixed

#114 pin hidapi dependency to 1.2.3 to enable macOS builds
#112 defmt decode errors are now reported to the user
#110 colorize assert_eq! output

v0.1.6 - 2020-11-23

Fixed

#109 <exception entry> is not printed twice in the backtrace when the firmware aborts.

Changed

#108 probe-rs has been bumped to version 0.10. This should fix some ST-LINK bugs and expand device support.

v0.1.5 - 2020-11-20

#106 probe-run now reports the program size
#105 probe-run's --defmt flag is now optional. probe-run will auto-detect the use of the defmt crate so the flag is no longer needed.
#259 building the crates.io version of probe-run no longer depends on the git command line tool (fixed [#256])
#264 probe-run doesn't panic if log message is not UTF-8

v0.1.4 - 2020-11-11

Added

#30 added a --no-flash flag to run a program without re-flashing it
#40 added (--help) documentation to the many CLI flags
#33 added canary-based stack overflow detection
#38 added file location information to log messages
#41 the PROBE_RUN_CHIP env variable can be used as an alternative to the --chip flag
#49 --list-probes and --probe flags to list all probes and select a particular probe, respectively
#55 added more precise stack overflow detection for apps linked with flip-link
#57 added module location information to log messages
#63 added file location information to the stack backtrace
#83 added git info to the --version output
#88 added --speed flag to set the frequency of the probe
#98 the output of --version now includes the supported defmt version

Fixed

#28 notify the user ASAP that RTT logs were not found in the image
#50 fixed a bug that was causing an infinite stack backtrace to be printed
#51 fixed the handling of Ctrl-C
#77 flush stdout after each write; fixes a bug where output was not printed until a newline was sent from the device using non-defmt-ed RTT

Changed

#25 increased RTT attach retries, which is sometimes needed for inter-operation with rtt-target
#44 improve diagnostics when linker script is missing
#53, #60 the output format of logs
#55, #64 all hard faults make probe-run exit with non-zero exit code regardless of whether panic-probe was used or not
#69 probe-run now changes the RTT mode to blocking at runtime, right after RAM initialization

v0.1.3 - 2020-08-19

Changed

Fixed outdated comment in readme

v0.1.2 - 2020-08-19

Added

Support for the thumbv7em-none-eabihf target.

Changed

Bumped the probe-rs dependency to 0.8.0
Cleaned up CLI documentation

v0.1.1 - 2020-08-17

Added

Added setup instructions to check that there's enough debug info to make the unwinder worker

Changed

Improved the error message produced when the unwinder fails

v0.1.0 - 2020-08-14

Initial release