Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enabling RTT in VSCode launch.json results in unstable debugger behaviour and experience #113

Open
jerrywrice opened this issue Feb 17, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@jerrywrice
Copy link

jerrywrice commented Feb 17, 2025

I followed the 'official' probe-rs debugger online documentation for setting up my rust VSCode project. The online docs show a launch.json section with entry settings that enabled RTT. While I've used other embedded debuggers (multiple in-fact), this was my first exposure to probe-rs (and I'm unfamiliar with RTT). Following these docs initially led to successfully loading/flashing my compiled embassy STM32 rust code to my Nucleo STM32F091RC dev-board. Then things went wrong. The target code initially started and ran, but unfortunately exhibited quite erratic behavior and faulty behavior. This is target code which I had previously tested and verified using other tools. This led to many hours of further examining the online probe-rs documents, and posting for feedback on the rust embassy matrix forum. After finding a couple of probe-rs code samples on other sites, it appeared that rust application code should (must?) be modified to make use of certain RTT features. I then chose to update my VSCode launch.json config section to remove/disable the RTT stuff. After this I reloaded by target code and the flakiness and erratic behavior seen previously was resolved!

IMO the installation documents, especially as it concerns the example VSCode launch.json configuration text shown with RTT enabled, should be revised to include very explicit and clear warnings within the inline comments of the example launch.json config section text 'to NOT enable RTT unless certain x/y/z preconditions are met'.

@noppej
Copy link
Contributor

noppej commented Feb 18, 2025

I am not aware of any specific preconditions that need to be met. Can you please provide details on what "preconditions" and "rust application should be modified" you found affected your use case?

@Yatekii Yatekii added the documentation Improvements or additions to documentation label Feb 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants