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

Point external documentation to this crate / stm32-rs #48

Open
1 of 5 tasks
dfrankland opened this issue Jan 1, 2020 · 8 comments
Open
1 of 5 tasks

Point external documentation to this crate / stm32-rs #48

dfrankland opened this issue Jan 1, 2020 · 8 comments

Comments

@dfrankland
Copy link
Member

dfrankland commented Jan 1, 2020 •
edited
Loading

We should likely update awesome-embedded-rust and also stm32f30x-hal to point to this crate since this crate is actively maintained. Related issue: japaric/stm32f30x-hal#36
@rubberduck203 rubberduck203 mentioned this issue Jan 4, 2020
Merged
@rubberduck203
Copy link
Contributor

I created a PR on awesome-embedded-rust to address this.
rust-embedded/awesome-embedded-rust#236

bors bot added a commit to rust-embedded/awesome-embedded-rust that referenced this issue Jan 4, 2020
@bors @rubberduck203
Merge #236
12650a7 
236: Point stmf32f3 users to currently maintained crate r=jamesmunns a=rubberduck203

Per stm32-rs/stm32f3xx-hal#48 and japaric/stm32f30x-hal#36, point stm32f3 users to the community supported stm32f3xx crate, instead of japaric's unmaintained stm32f30x crate.

Co-authored-by: Christopher McClellan <chris.mcclellan203@gmail.com>
@rubberduck203
Copy link
Contributor

This is done.

@Sh3Rm4n
Copy link
Member

Sh3Rm4n commented Jan 4, 2020

Should we wait to close this issue, until japaric/f3#109
is merged?

cc @dfrankland

@Sh3Rm4n
Copy link
Member

Sh3Rm4n commented Jan 4, 2020

Thank you for taking action and submitting a PR to awesome-embedded-rust @rubberduck203 👍

@rubberduck203
Copy link
Contributor

@Sh3Rm4n I’m unsure what the PR on f3 has to do with this issue.

@Sh3Rm4n
Copy link
Member

Sh3Rm4n commented Jan 5, 2020

Yeah, you are right, this is not directly related to this issue. I'll let @dfrankland decide to close this issue :)

@dfrankland
Copy link
Member Author

dfrankland commented Jan 6, 2020 •
edited
Loading

I think we are all good with the work @rubberduck203 put in for awesome-embedded-rust. Thank you!

Considering the amount of documentation that links to stm32f30x-hal I think it'll be good to get japaric/stm32f30x-hal#36 closed as well. An example of this, is the The Embedded Rust Book, as of today, still points to stm32f30x (look under "Peripheral Access Crate (PAC)"):
https://github.com/rust-embedded/book/blob/9f103c2a8aa91b959c7cddd31c950803d3ec06cc/src/start/registers.md. You can even check by Googling "stm32f30x" rust.

I think I'll make a checklist at the top and start checking some of the items off.

@dfrankland dfrankland changed the title Point external documentation to this crate Point external documentation to this crate / stm32-rs Jan 6, 2020
@rubberduck203 rubberduck203 mentioned this issue Jan 11, 2020
Open
@vringar
Copy link

vringar commented Jun 13, 2021

The outdated crate is also linked in the embedded-hal docs and should probably be replaced there as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@dfrankland @rubberduck203 @vringar @Sh3Rm4n