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

Make glossary more linkable and add more detail #299

Merged
merged 4 commits into from
Aug 26, 2021
Merged

Make glossary more linkable and add more detail #299

merged 4 commits into from
Aug 26, 2021

Conversation

robyoung
Copy link
Contributor

@robyoung robyoung commented Aug 25, 2021 •
edited
Loading

While writing a blog post I found that I wanted to be able to link to a common definition of certain terms but I was not able to find one.

This change makes the glossary up from sub-headings so that each item can be linked to directly. I have also filled out some more detail on the areas I'm particularly interested in (BSP, HAL and PAC).

Things I'm not sure about:

  • I am very new to embedded development so please review what I've written carefully, it may not be correct.
  • I'm not sure how much detail to put here as there seems to be a bit of overlap with the registers page. I've gone with more detail here because I would like to link to these definitions from outside this book.

@robyoung
Make glossary more linkable and add more detail
a26f48a 
While writing a blog post I found that I wanted to be able to link to a
common definition of certain terms but I was not able to find one.

This changes makes the glossary up from sub-headings so that each item
can be linked to directly. I have also filled out some more detail on
the areas I'm particularly interested in (BSP, HAL and PAC).
@robyoung robyoung requested a review from a team as a code owner August 25, 2021 11:35
@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 @jamesmunns (or someone else) soon.

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 Aug 25, 2021
eldruin
eldruin reviewed Aug 25, 2021
View reviewed changes
Copy link
Member

@eldruin eldruin left a comment

Choose a reason for hiding this comment

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

This is definitely an improvement, thanks!

src/appendix/glossary.md Outdated Show resolved Hide resolved
src/appendix/glossary.md Outdated Show resolved Hide resolved
src/appendix/glossary.md Outdated Show resolved Hide resolved
src/appendix/glossary.md Outdated Show resolved Hide resolved
src/appendix/glossary.md Outdated Show resolved Hide resolved
src/appendix/glossary.md Outdated Show resolved Hide resolved
robyoung and others added 2 commits August 25, 2021 13:18
@hargoniX
Copy link
Member

Maybe you could add a link to thezoq's talk about terminology: https://www.youtube.com/watch?v=vLYit_HHPaY I did that as well over in the discovery book rewrite...makes me think, maybe we should have some "single source of truth" regarding terminology like this we can always link in our resources to decrease redundancy.

@robyoung
Copy link
Contributor Author

makes me think, maybe we should have some "single source of truth" regarding terminology like this we can always link in our resources to decrease redundancy

that is exactly what I was looking for and what I hope this page could be. The main rust-embedded book certainly feels like the right general area.

@robyoung
Copy link
Contributor Author

robyoung commented Aug 25, 2021 •
edited
Loading

Oh my goodness, that video looks amazing 😍 ! Definitely watching that this evening when I can absorb it properly.

Once I've watched it I will try to link directly to the correct time in the video for each definition. After watching the video I think deep linking would not be helpful as you lose the context.

eldruin
eldruin approved these changes Aug 26, 2021
View reviewed changes
Copy link
Member

@eldruin eldruin left a comment

Choose a reason for hiding this comment

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

Looks good to me, thank you!
bors r+

@bors
Copy link
Contributor

bors bot commented Aug 26, 2021

Build succeeded:

@bors bors bot merged commit c3a51e2 into rust-embedded:master Aug 26, 2021
@robyoung robyoung deleted the make-glossary-linkable branch August 26, 2021 11:17
@ehuss ehuss mentioned this pull request Sep 1, 2021
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 1, 2021
@bors
Auto merge of rust-lang#88563 - ehuss:update-cargo-books, r=ehuss
50171c3 
Update cargo, books

## nomicon

2 commits in 0c7e5bd1428e7838252bb57b7f0fbfda4ec82f02..fe6227eb3c8533200c52dffa42ef1b6f2f02c40e
2021-08-04 10:18:22 -0700 to 2021-08-31 05:42:38 +0900
- update lifetime-elision to show what elided code under `rust_2018_idi… (rust-lang/nomicon#306)
- Change code for `into_iter` on the `RawVec` section for consistency/soundness (rust-lang/nomicon#302)

## cargo

8 commits in f559c109cc79fe413a8535fb620a5a58b3823d94..18751dd3f238d94d384a7fe967abfac06cbfe0b9
2021-08-26 22:54:55 +0000 to 2021-09-01 14:26:00 +0000
- print the full destination path when no track duplicates (rust-lang/cargo#9850)
- Stabilize 2021 edition (rust-lang/cargo#9800)
- Stabilize patch-in-config (and prefer config over manifest) (rust-lang/cargo#9839)
- Adding the cargo doc --examples subcommand (rust-lang/cargo#9808)
- Make library created with `cargo new` clippy happy (rust-lang/cargo#9796)
- Swap out some outdated repo urls in documentation (rust-lang/cargo#9862)
- Change `cargo fix --edition` to only fix edition lints. (rust-lang/cargo#9846)
- Show desc of well known subcommands (fmt, clippy) in cargo --list (rust-lang/cargo#9848)

## reference

1 commits in da6ea9b03f74cae0a292f40315723d7a3a973637..0e5ed7a4bec065f0cc18c35d1c904639e095314d
2021-08-19 21:28:10 -0700 to 2021-08-29 17:33:21 +0900
- expressions.md: Attempt fixing broken grammar in Mutability paragraph (rust-lang/reference#1084)

## book

1 commits in 687e21bde2ea10c261f79fa14797c5137425098d..fcb5e0ea68112d85a1d29a7a7335978ef2a02181
2021-08-18 20:48:38 -0400 to 2021-08-31 21:26:19 -0400
- Improve the reading of the code (rust-lang/book#2845)

## rustc-dev-guide

7 commits in cf0e151..95f1acf
2021-08-22 11:47:02 -0300 to 2021-08-31 12:38:30 -0500
- Add link to `Span`
- Add rustc-source to suggested rust-analyzer config (rust-lang/rustc-dev-guide#1189)
- Fix typo, clarify backtick wording, and use inline code
- Trailing date comments in a line inside of a paragraph caused beginning of a new paragraph. (rust-lang/rustc-dev-guide#1196)
- Fix warning "Renderer command uses a path relative to the renderer output directory ..." (rust-lang/rustc-dev-guide#1194)
- Fix a code block containing ```rust
- date-check: Recognize capitalized 'Date' as well

## edition-guide

1 commits in 3710b0cae783d0bcd2b42452a63b081473f5970a..2d9b1b9da706de24650fdc5c3b0182f55c82115d
2021-07-26 11:34:46 -0700 to 2021-08-31 10:44:09 +0200
- Update for 2021 stabilization (rust-lang/edition-guide#266)

## embedded-book

1 commits in 4f9fcaa30d11ba52b641e6fd5206536d65838af9..c3a51e23859554369e6bbb5128dcef0e4f159fb5
2021-08-06 17:43:12 +0000 to 2021-08-26 07:04:58 +0000
- Make glossary more linkable and add more detail  (rust-embedded/book#299)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eldruin eldruin eldruin approved these changes

Assignees

@jamesmunns jamesmunns

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.
5 participants
@robyoung @rust-highfive @hargoniX @eldruin @jamesmunns