Installation section doesn't specify target needed for QEMU section
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- rust
- Domain
- documentation, embedded-iot
Research direction
Start with sections 1.4 (Installation) and 2.1 (QEMU), comparing the documented STM32F3DISCOVERY and LM3S6965 targets. Clarify that QEMU needs the thumbv7m-none-eabi target and show the corresponding rustup command. Done means readers can install the required target before building the QEMU example.
Written by the indexing model from the issue text.
Description
Under section 1.4 (Installation), the book instructs the reader to specifically install cross-compilation support for the STM32F3DISCOVERY via the thumbv7em-none-eabihf target.
However, shortly after in section 2.1 (QEMU), the book has the reader build a program targeting the LM3S6965, a Cortext-M3 microcontroller that requires the thumbv7m-none-eabi target. Following the instructions as they are will result in a build error, so it might be good to indicate at this point that this target is different from the target specified in the installation section, and that the user must use a similar command to install support for this target:
$ rustup target add thumbv7m-none-eabi
It's pretty obvious what to do as-is, but at the same time, the subtle differences between the various $TRIPLE targets may confuse readers not familiar with the various ARM targets.
- Dominant language
- No language data
- Stars
- 1.3k
- Forks
- 223
- PR merge metrics
- No merged PRs in 30d
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.
More from rust-embedded/book
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
rust-embedded/book#414 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 62/100
rust-embedded/book#370 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
rust-embedded/book#345 · 2 reactions ·
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
rust-embedded/book#208 ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 65/100
rust-embedded/book#147 ·
All issues in rust-embedded/book
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
bancolombia/sentinel#22 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
optimization optimization:agents-md-curator
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
githubnext/gh-aw-cao#13143 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 94/100
objectionary/hone-maven-plugin#1061 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
redhat-developer/rhdh-plugins#4887 · 2 comments ·