Mention the critical-section crate?

Open Beginner friendly
#345 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
documentation, embedded-iot

Research direction

Start with the concurrency section at https://docs.rust-embedded.org/book/concurrency/index.html and review how it explains sharing data. Add an introduction to the critical-section crate that explains how it addresses sharing data on multi-core systems. Done means the documentation covers this missing case clearly and links readers to the crate.

Written by the indexing model from the issue text.

Description

https://docs.rust-embedded.org/book/concurrency/index.html talks about sharing data, and hand-waves over what to do on a multi-core system. We should introduce critical-section here, which specifically resolves this issue.

Dominant language
No language data
Stars
1.3k
Forks
223
No merged PRs in 30d

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.

More from rust-embedded/book

All issues in rust-embedded/book

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.