rust-embedded / rust-embedded/svd2rust
Unclear how to use `#[interrupt]` macro without deprecated `--reexport-interrupt` flag
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 857
- Forks
- 164
- PR merge metrics
- No merged PRs in 30d
Description
According to the documentation of svd2rust, the --reexport-interrupt flag is deprecated. However according to the documentation of cortex-m-rt, the #[interrupt] macro should only be used via the svd2rust reexport, and indeed it fails to compile when used directly, with a confusing error.
How is the interrupt macro supposed to be used without the --reexport-interrupt flag passed to svd2rust? This should at least be documented clearly in the svd2rust documentation.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the linked svd2rust and cortex-m-rt documentation and reproduce the confusing compile error when using #[interrupt] directly. Determine the supported usage without --reexport-interrupt, then update the svd2rust documentation so the correct setup and expected behavior are clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100