rust-embedded / rust-embedded/cortex-m

Make it more obvious that the `inline-asm` feature is deprecated and does nothing

Open
#644 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1k
Forks
202
Avg merge
6d 2h
Merged PRs (30d)
2

Description

The inline-asm feature is a relic of the time before inline asm was supported in stable rust. We should do something to make it more obvious that that feature now does nothing and will be removed in a future major version.

One idea might be to at least have a message from build.rs that is output when the inline-asm feature is active is used.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting build.rs and how the inline-asm feature is detected or exposed. Add a clear message when the feature is enabled, indicating that it is deprecated, has no effect, and will be removed in a future major version. Confirm the message appears when the feature is used.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
embedded-iot
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.