Skip to content

cargo-embedprobe-rs documentation change - #82

Open
BobAdamsEE wants to merge 7 commits into
atsams-rs:developmentfrom
BobAdamsEE:patch-1
Open

cargo-embedprobe-rs documentation change#82
BobAdamsEE wants to merge 7 commits into
atsams-rs:developmentfrom
BobAdamsEE:patch-1

Conversation

@BobAdamsEE

@BobAdamsEE BobAdamsEE commented May 5, 2025

Copy link
Copy Markdown

Attempting to install cargo-embed with instructions from the current boards/atsamv71_xult/README.md lead to the following:

  `cargo-embed` is now a part of `probe-rs`. To install it, run the following PowerShell command:

  irm https://github.com/probe-rs/probe-rs/releases/latest/download/probe-rs-tools-installer.ps1 | iex

  Once installed, you can use the "cargo embed" command just like before, although there might be minor changes in the API. For more information, please refer to the documentation at https://probe.rs/docs/tools/cargo-embed/.

Updated boards/atsamv71_xult/README.md with the relevant instructions for probe-rs for Windows / Linux.

BobAdamsEE added 2 commits May 5, 2025 10:27
`cargo-embed` is now a part of `probe-rs`.
Updating per suggestion in contribution guide
@BobAdamsEE BobAdamsEE changed the title Patch 1 cargo-embed -> probe-rs documentation change May 5, 2025
@BobAdamsEE
BobAdamsEE marked this pull request as draft May 5, 2025 15:20
@BobAdamsEE

Copy link
Copy Markdown
Author

This will need further work - probe-rs has issues with the Embed.toml from changes from the initial cargo-embed. Will submit again once I get flashing working.

@michalfita michalfita left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not author of this demo and I don't use it, hence missed the change that seem to happen in 2023. Thanks for efforts to improve the documentation.

Comment thread CHANGELOG.md Outdated
Comment thread boards/atsamv71_xult/README.md Outdated
@michalfita michalfita changed the title cargo-embed -> probe-rs documentation change cargo-embedprobe-rs documentation change May 5, 2025
Comment thread boards/atsamv71_xult/README.md Outdated
@BobAdamsEE BobAdamsEE closed this May 6, 2025
@BobAdamsEE
BobAdamsEE deleted the patch-1 branch May 6, 2025 12:05
@BobAdamsEE
BobAdamsEE restored the patch-1 branch May 6, 2025 12:15
Fixed errors that cause cargo embed to not work including show_timestamps as a general default.rtt setting (now per up_channel), halt_afterwards in the default.flashing section, and the channels parameter of default.rtt was split into up_channels and down_channels.
@BobAdamsEE BobAdamsEE reopened this May 6, 2025
BobAdamsEE and others added 3 commits May 6, 2025 08:20
Remove windows style of paths

Co-authored-by: Michał Fita <4925040+michalfita@users.noreply.github.com>
Co-authored-by: Michał Fita <4925040+michalfita@users.noreply.github.com>
Per recommendation removed curl | sh notes - users can reference current documentation from probe-rs site directly
@BobAdamsEE

Copy link
Copy Markdown
Author

Resolved review comments and updated Embed.TOML to handle some changes from probe-rs:

@BobAdamsEE
BobAdamsEE marked this pull request as ready for review May 6, 2025 12:31

@michalfita michalfita left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I think it's good enough.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants