rust-embedded / rust-embedded/cortex-m
CHANGELOG.md is imprecise on/after v0.6.5
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1k
- Forks
- 202
- Avg merge
- 6d 2h
- Merged PRs (30d)
- 2
Description
Due to the semver trick (was that the name?) v0.6.5, and later v0.6.x releases, depend on v0.7.x. This means that if you use v0.6.5 you may observe changes in behavior introduced in the v0.7.x line. The changelog doesn't mention which API may be subject to these changes in behavior (e.g. see #325 ), i.e. which API are re-exported from v0.7.x.
(On a side note, the semver trick also makes it harder to pin a cortex-m version in Cargo.toml, e.g.
[dependencies]
cortex-m = "=0.6.5" # pin cortex-m dependency (?)
this will not pin the cortex-m v0.7.x dependency so you may still get v0.7.0 or v0.7.1)
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 with CHANGELOG.md and compare the v0.6.5 and later v0.6.x entries with the v0.7.x API changes, including the behavior referenced by #325. Update the changelog to identify which APIs are re-exported and may change behavior through the semver trick; done means the affected API surface and dependency caveat are explicit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100