Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improved hardware.md chapter. #361

Merged
merged 1 commit into from
Oct 16, 2023
Merged

Improved hardware.md chapter. #361

merged 1 commit into from
Oct 16, 2023

Conversation

armaxri
Copy link
Contributor

@armaxri armaxri commented Oct 16, 2023

If you follow the documentation blindly, you will end up in a trap with strange compiler warnings. This fix adds a warning about that.

@armaxri
Improved hardware.md chapter.
62be475 
If you follow the documentation blindly, you will end up in a trap with strange compiler warnings. This fix adds a warning about that.
@armaxri armaxri requested a review from a team as a code owner October 16, 2023 22:40
adamgreig
adamgreig approved these changes Oct 16, 2023
View reviewed changes
Copy link
Member

@adamgreig adamgreig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I think the installation section of the intro chapter does say to use this target for the hardware board, but it's not very clear and a reminder will be helpful.

@adamgreig adamgreig added this pull request to the merge queue Oct 16, 2023
@armaxri
Copy link
Contributor Author

armaxri commented Oct 16, 2023

Actually it uses a different target, which makes everything a little bit confusing. The book talks about the STM32F3 and you have to install the Cortex M3 (the correct) dependencies and in this chapter it jumps to the Cortex M4F...
I'm checking everything right now as an after midnight project, so it will take a few days but maybe there will be a bigger PR later.

Merged via the queue into rust-embedded:master with commit 22bca3d Oct 16, 2023
1 check passed
@adamgreig
Copy link
Member

The STM32F3 has a Cortex-M4F CPU core, so thumbv7em-none-eabihf is the right target, which is what this page means when it says

For the STM32F3DISCOVERY board used for the examples in this book, use the thumbv7em-none-eabihf target.

It is a bit confusing that the "STM32F3" has a Cortex-M4F, but it's just how it is - the STM32F4 is also Cortex-M4F, the STM32F1 is Cortex-M3, the STM32H7 is Cortex-M7, but the STM32H5 is Cortex-M33 and so forth.

@armaxri
Copy link
Contributor Author

armaxri commented Oct 16, 2023

Thanks a lot! That got me really confused but now I'm back on track! Thanks!

@armaxri armaxri deleted the patch-1 branch October 16, 2023 23:02
@rustbot rustbot mentioned this pull request Oct 23, 2023
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Oct 24, 2023
@matthiaskrgr
Rollup merge of rust-lang#117093 - rustbot:docs-update, r=ehuss
5a0e51e 
Update books

## rust-lang/book

1 commits in 72187f5cd0beaaa9c6f584156bcd88f921871e83..3dca2fc50b922a8efb94903b9fee8bb42ab48f38
2023-10-19 18:01:47 UTC to 2023-10-19 18:01:47 UTC

- Fix cargo doc links (rust-lang/book#3751)

## rust-embedded/book

1 commits in eac173690b8cc99094e1d88bd49dd61127fbd285..22bca3d0f6e9b9b556689b54ce96f25b46ecd1b3
2023-10-16 22:47:38 UTC to 2023-10-16 22:47:38 UTC

- Improved hardware.md chapter. (rust-embedded/book#361)

## rust-lang/nomicon

1 commits in ddfa4214487686e91b21aa29afb972c08a8f0d5b..1842257814919fa62e81bdecd5e8f95be2839dbb
2023-10-17 15:11:58 UTC to 2023-10-17 15:11:58 UTC

- Fixed `Hole::get` marked as unsafe in `exception-safety.md` (rust-lang/nomicon#427)

## rust-lang/reference

2 commits in 142b2ed77d33f37a9973772bd95e6144ed9dce43..16fd3c06d9e558dae2d52000818274ae70c9e90a
2023-10-14 22:31:04 UTC to 2023-10-11 15:35:55 UTC

- Adjust reference for return-position `impl Trait` in trait and `async fn` in trait (rust-lang/reference#1409)
- Fix temporary drop scope for last expression. (rust-lang/reference#1416)

## rust-lang/rust-by-example

1 commits in 8eb3a01ab74c567b7174784892fb807f2c632d6b..6709beeb7d0fbc5ffc91ac4893a24434123b9bfa
2023-10-20 19:11:21 UTC to 2023-10-20 19:11:21 UTC

- docs: fix a typo (rust-lang/rust-by-example#1752)

## rust-lang/rustc-dev-guide

5 commits in b98af7d661e4744baab81fb8dc7a049e44a4a998..b0ee9ec8fa59a6c7620165e061f4747202377a62
2023-10-22 03:18:44 UTC to 2023-10-11 06:30:26 UTC

- Add WF to glossary (rust-lang/rustc-dev-guide#1810)
- recommend `unpretty=hir` alongside `unpretty=hir-tree` (rust-lang/rustc-dev-guide#1804)
- Start a chapter about the evolving const effect system (rust-lang/rustc-dev-guide#1808)
- Document subtle implied bounds issue in RPITIT inference (rust-lang/rustc-dev-guide#1807)
- [suggested.md]  `changelog-seen` -> `change-id` in `shell.nix` (rust-lang/rustc-dev-guide#1806)
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Oct 24, 2023
@rust-timer
Unrolled build for rust-lang#117093
40313a1 
Rollup merge of rust-lang#117093 - rustbot:docs-update, r=ehuss

Update books

## rust-lang/book

1 commits in 72187f5cd0beaaa9c6f584156bcd88f921871e83..3dca2fc50b922a8efb94903b9fee8bb42ab48f38
2023-10-19 18:01:47 UTC to 2023-10-19 18:01:47 UTC

- Fix cargo doc links (rust-lang/book#3751)

## rust-embedded/book

1 commits in eac173690b8cc99094e1d88bd49dd61127fbd285..22bca3d0f6e9b9b556689b54ce96f25b46ecd1b3
2023-10-16 22:47:38 UTC to 2023-10-16 22:47:38 UTC

- Improved hardware.md chapter. (rust-embedded/book#361)

## rust-lang/nomicon

1 commits in ddfa4214487686e91b21aa29afb972c08a8f0d5b..1842257814919fa62e81bdecd5e8f95be2839dbb
2023-10-17 15:11:58 UTC to 2023-10-17 15:11:58 UTC

- Fixed `Hole::get` marked as unsafe in `exception-safety.md` (rust-lang/nomicon#427)

## rust-lang/reference

2 commits in 142b2ed77d33f37a9973772bd95e6144ed9dce43..16fd3c06d9e558dae2d52000818274ae70c9e90a
2023-10-14 22:31:04 UTC to 2023-10-11 15:35:55 UTC

- Adjust reference for return-position `impl Trait` in trait and `async fn` in trait (rust-lang/reference#1409)
- Fix temporary drop scope for last expression. (rust-lang/reference#1416)

## rust-lang/rust-by-example

1 commits in 8eb3a01ab74c567b7174784892fb807f2c632d6b..6709beeb7d0fbc5ffc91ac4893a24434123b9bfa
2023-10-20 19:11:21 UTC to 2023-10-20 19:11:21 UTC

- docs: fix a typo (rust-lang/rust-by-example#1752)

## rust-lang/rustc-dev-guide

5 commits in b98af7d661e4744baab81fb8dc7a049e44a4a998..b0ee9ec8fa59a6c7620165e061f4747202377a62
2023-10-22 03:18:44 UTC to 2023-10-11 06:30:26 UTC

- Add WF to glossary (rust-lang/rustc-dev-guide#1810)
- recommend `unpretty=hir` alongside `unpretty=hir-tree` (rust-lang/rustc-dev-guide#1804)
- Start a chapter about the evolving const effect system (rust-lang/rustc-dev-guide#1808)
- Document subtle implied bounds issue in RPITIT inference (rust-lang/rustc-dev-guide#1807)
- [suggested.md]  `changelog-seen` -> `change-id` in `shell.nix` (rust-lang/rustc-dev-guide#1806)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adamgreig adamgreig adamgreig approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@armaxri @adamgreig