Skip to content

Commit

Permalink
Replace probe-run with probe-rs
Browse files Browse the repository at this point in the history
This commit replaces all references to probe-run with probe-rs, as it
was deprecated and superseded by probe-rs.
(https://ferrous-systems.com/blog/probe-run-deprecation/)
  • Loading branch information
sefidel authored and korken89 committed Nov 11, 2023
1 parent c1ffa72 commit d43dca4
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 14 deletions.
8 changes: 4 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ overflow-checks = false # <-
# uncomment this to switch from the crates.io version of defmt to its git version
# check app-template's README for instructions
# [patch.crates-io]
# defmt = { git = "https://github.com/knurling-rs/defmt", rev = "use defmt version reported by `probe-run --version`" }
# defmt-rtt = { git = "https://github.com/knurling-rs/defmt", rev = "use defmt version reported by `probe-run --version`" }
# defmt-test = { git = "https://github.com/knurling-rs/defmt", rev = "use defmt version reported by `probe-run --version`" }
# panic-probe = { git = "https://github.com/knurling-rs/defmt", rev = "use defmt version reported by `probe-run --version`" }
# defmt = { git = "https://github.com/knurling-rs/defmt", rev = "use defmt version supported by probe-rs (see changelog)" }
# defmt-rtt = { git = "https://github.com/knurling-rs/defmt", rev = "use defmt version supported by probe-rs (see changelog)" }
# defmt-test = { git = "https://github.com/knurling-rs/defmt", rev = "use defmt version supported by probe-rs (see changelog)" }
# panic-probe = { git = "https://github.com/knurling-rs/defmt", rev = "use defmt version supported by probe-rs (see changelog)" }
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# `app-template`

> Quickly set up a [`probe-run`] + [`defmt`] + [`flip-link`] embedded project
> Quickly set up a [`probe-rs`] + [`defmt`] + [`flip-link`] embedded project
> running on the [`RTIC`] scheduler
[`probe-run`]: https://crates.io/crates/probe-run
[`probe-rs`]: https://crates.io/crates/probe-rs
[`defmt`]: https://github.com/knurling-rs/defmt
[`flip-link`]: https://github.com/knurling-rs/flip-link
[`RTIC`]: https://rtic.rs/
Expand All @@ -18,11 +18,10 @@ Based on https://github.com/knurling-rs/app-template
$ cargo install flip-link
```

#### 2. `probe-run`:
#### 2. `probe-rs`:

``` console
$ # make sure to install v0.2.0 or later
$ cargo install probe-run
$ cargo install probe-rs --features cli
```

## Setup
Expand All @@ -37,9 +36,9 @@ If you look into your new `test-app` folder, you'll find that there are a few `T

Let's walk through them together now.

#### 2. Set `probe-run` chip
#### 2. Set `probe-rs` chip

Pick a chip from `probe-run --list-chips` and enter it into `.cargo/config.toml`.
Pick a chip from `probe-rs chip list` and enter it into `.cargo/config.toml`.

If, for example, you have a nRF52840 Development Kit from one of [our workshops], replace `$CHIP` with `nRF52840_xxAA`.

Expand All @@ -48,8 +47,8 @@ If, for example, you have a nRF52840 Development Kit from one of [our workshops]
```diff
# .cargo/config.toml
[target.'cfg(all(target_arch = "arm", target_os = "none"))']
-runner = "probe-run --chip $CHIP"
+runner = "probe-run --chip nRF52840_xxAA"
-runner = "probe-rs run --chip $CHIP"
+runner = "probe-rs run --chip nRF52840_xxAA"
```

#### 3. Adjust the compilation target
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ defmt::timestamp!("{=usize}", {
n
});

/// Terminates the application and makes `probe-run` exit with exit-code = 0
/// Terminates the application and makes `probe-rs` exit with exit-code = 0
pub fn exit() -> ! {
loop {
cortex_m::asm::bkpt();
Expand Down

0 comments on commit d43dca4

Please sign in to comment.