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

Ease the readers into the Discovery book #250

Merged
merged 6 commits into from
Jun 16, 2020
Merged

Ease the readers into the Discovery book #250

merged 6 commits into from
Jun 16, 2020

Conversation

blelem
Copy link

@blelem blelem commented Jun 14, 2020

resolves #195

The book has a great and slow introduction to embedded rust using the STM32F3, writing an hello world and then at chapter "Memory-Map registers" takes a hard turn, goes quite hardcore into hardware registers, using other hardware than the STM32F3. That can be quite intimidating for someone new to embedded world, who doesn't quite yet know what systick is, and may just want to blink some leds on his board.

For those Sunday tinkerers that got started with the rust-embedded book that do not yet have the technical chops to go through these details, I tried to write an escape hatch to the more palatable Discovery Book.

I also updated a few bits of code that needed updates to match the latest tools update.

@blelem blelem requested a review from a team as a code owner June 14, 2020 07:39
@rust-highfive
Copy link

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @therealprof (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@rust-highfive rust-highfive added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-resources labels Jun 14, 2020
adamgreig
adamgreig reviewed Jun 14, 2020
View reviewed changes
src/start/registers.md Outdated Show resolved Hide resolved
@adamgreig
Copy link
Member

Thanks for this update, looks good!

I wonder if we should link to the newer https://crates.io/crates/stm32f3-discovery crate, which is recently updated, rather than the old f3 crate, which hasn't been updated in 2 years.

@blelem
Copy link
Author

blelem commented Jun 15, 2020

Thanks @adamgreig for the quick review!

I wonder if we should link to the newer https://crates.io/crates/stm32f3-discovery crate, which is recently updated, rather than the old f3 crate, which hasn't been updated in 2 years.

I agree, linking to a maintained crate sounds much better. I've updated my PR accordingly.
The Discovery book still uses that old f3 crate, let see how easily I can switch the crate to the stm32f3-discovery crate.

@therealprof
Copy link
Contributor

Sounds good to me. Thanks for keeping at it.

adamgreig
adamgreig previously approved these changes Jun 15, 2020
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!

bors merge

@bors
Copy link
Contributor

bors bot commented Jun 15, 2020

Merge conflict.

@adamgreig
Copy link
Member

Ah boo, this is conflicting with #248 which made the same use crate as _ changes. Please could you rebase or merge with master to resolve them?

@blelem
Copy link
Author

blelem commented Jun 16, 2020

Merge conflict resolved!

adamgreig
adamgreig approved these changes Jun 16, 2020
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!

bors merge

@bors
Copy link
Contributor

bors bot commented Jun 16, 2020

Build succeeded:

@bors bors bot merged commit 04a47f9 into rust-embedded:master Jun 16, 2020
@ehuss ehuss mentioned this pull request Jun 24, 2020
Merged
Manishearth added a commit to Manishearth/rust that referenced this pull request Jun 24, 2020
@Manishearth
Rollup merge of rust-lang#73675 - ehuss:update-books, r=ehuss
ac13194 
Update books

## reference

5 commits in 5d40ba5c2515caffa7790cda621239dc21ef5a72..04d5d5d7ba624b6f5016298451f3a63d557f3260
2020-06-06 20:25:36 -0700 to 2020-06-16 15:08:05 -0700
- Mention `feature="foo"` is a Cargo convention. (rust-lang/reference#833)
- fix out of date info on type aliases (rust-lang/reference#831)
- Fix an invalid variable name in the loop example (rust-lang/reference#832)
- Fix note about using proc_macro with Cargo. (rust-lang/reference#815)
- Add a link to the definition of Pattern_White_Space. (rust-lang/reference#824)

## book

7 commits in 30cd9dfe71c446de63826bb4472627af45acc9db..4e7c00bece1544d409312ec93467beb62b5bd0cb
2020-06-07 23:07:19 -0500 to 2020-06-19 09:39:12 -0400
- Link to the reference file that exists
- Link to the reference
- Clean up discussion around advanced lifetime stuff (rust-lang/book#2351)
- Reword Chapter 6 page 2, match (rust-lang/book#2374)
- Clarify some package/crate distinctions in chapter 14 (rust-lang/book#2373)
- Not mandatory with cargo 1.41.0-nightly (rust-lang/book#2368)
- Use same naming for Rhs as libcore/ops (rust-lang/book#2371)

## rust-by-example

4 commits in 7aa82129aa23e7e181efbeb8da03a2a897ef6afc..6f94ccb48da6fa4ed0031290f21411cf789f7d5e
2020-05-25 14:54:26 -0300 to 2020-06-20 17:51:30 -0300
- Update to mdbook 0.3.7 (rust-lang/rust-by-example#1352)
- Update fn.md (rust-lang/rust-by-example#1351)
- Fixed typo in formatted print (rust-lang/rust-by-example#1350)
- This explanation incorrectly inverts the meaning of SuperTrait (rust-lang/rust-by-example#1349)

## embedded-book

5 commits in 5555a97f04ad7974ac6fb8fb47c267c4274adf4a..616962ad0dd80f34d8b802da038d0aed9dd691bb
2020-05-25 18:00:51 +0000 to 2020-06-23 16:03:45 +0000
- Update RTFM name to RTIC, fixed links, updated singletons.md example.  (rust-embedded/book#254)
- Note on how to rebuild if memory.x is changed  (rust-embedded/book#253)
- Ease the readers into the Discovery book  (rust-embedded/book#250)
- Provide a note on 'extern crate' usage in edition 2018 syntax of Rust  (rust-embedded/book#248)
- Fix Typos and Improve Readability  (rust-embedded/book#245)
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Jun 24, 2020
@Dylan-DPC
Rollup merge of rust-lang#73675 - ehuss:update-books, r=ehuss
be8f381 
Update books

## reference

5 commits in 5d40ba5c2515caffa7790cda621239dc21ef5a72..04d5d5d7ba624b6f5016298451f3a63d557f3260
2020-06-06 20:25:36 -0700 to 2020-06-16 15:08:05 -0700
- Mention `feature="foo"` is a Cargo convention. (rust-lang/reference#833)
- fix out of date info on type aliases (rust-lang/reference#831)
- Fix an invalid variable name in the loop example (rust-lang/reference#832)
- Fix note about using proc_macro with Cargo. (rust-lang/reference#815)
- Add a link to the definition of Pattern_White_Space. (rust-lang/reference#824)

## book

7 commits in 30cd9dfe71c446de63826bb4472627af45acc9db..4e7c00bece1544d409312ec93467beb62b5bd0cb
2020-06-07 23:07:19 -0500 to 2020-06-19 09:39:12 -0400
- Link to the reference file that exists
- Link to the reference
- Clean up discussion around advanced lifetime stuff (rust-lang/book#2351)
- Reword Chapter 6 page 2, match (rust-lang/book#2374)
- Clarify some package/crate distinctions in chapter 14 (rust-lang/book#2373)
- Not mandatory with cargo 1.41.0-nightly (rust-lang/book#2368)
- Use same naming for Rhs as libcore/ops (rust-lang/book#2371)

## rust-by-example

4 commits in 7aa82129aa23e7e181efbeb8da03a2a897ef6afc..6f94ccb48da6fa4ed0031290f21411cf789f7d5e
2020-05-25 14:54:26 -0300 to 2020-06-20 17:51:30 -0300
- Update to mdbook 0.3.7 (rust-lang/rust-by-example#1352)
- Update fn.md (rust-lang/rust-by-example#1351)
- Fixed typo in formatted print (rust-lang/rust-by-example#1350)
- This explanation incorrectly inverts the meaning of SuperTrait (rust-lang/rust-by-example#1349)

## embedded-book

5 commits in 5555a97f04ad7974ac6fb8fb47c267c4274adf4a..616962ad0dd80f34d8b802da038d0aed9dd691bb
2020-05-25 18:00:51 +0000 to 2020-06-23 16:03:45 +0000
- Update RTFM name to RTIC, fixed links, updated singletons.md example.  (rust-embedded/book#254)
- Note on how to rebuild if memory.x is changed  (rust-embedded/book#253)
- Ease the readers into the Discovery book  (rust-embedded/book#250)
- Provide a note on 'extern crate' usage in edition 2018 syntax of Rust  (rust-embedded/book#248)
- Fix Typos and Improve Readability  (rust-embedded/book#245)
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

@therealprof therealprof

Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-resources
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Hardware example inconsistency (STM32F3 versus TM4C123x)
4 participants
@blelem @rust-highfive @adamgreig @therealprof