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.

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

Change reference implementation to something more maintained #156

Closed
TheZoq2 opened this issue Oct 26, 2019 · 10 comments · Fixed by #251
Closed

Change reference implementation to something more maintained #156

TheZoq2 opened this issue Oct 26, 2019 · 10 comments · Fixed by #251
Labels
nominated Issue nominated as discussion topic for the Embedded WG meeting
Milestone

Comments

@TheZoq2
Copy link

TheZoq2 commented Oct 26, 2019

While scrolling through the docs tooday, I noticed the line

The stm32f30x-hal crate contains a reference implementation of this HAL.

As far as I can tell, this crate hasn't been updated in two years, and is kind of superseded by the stm32-rs maintained version.

Therefore I think it would make sense to switch the reference implementation to something else, or to remove the line completely.

@therealprof
Copy link
Contributor

@TheZoq2 Which docs? Can you do a PR with the fix?

@TheZoq2
Copy link
Author

TheZoq2 commented Oct 27, 2019

I guess I should have clarified that :P. The main page of the docs on docs.rs https://docs.rs/embedded-hal/0.2.3/embedded_hal/#reference-implementation

I'll gladly do a PR, but i'm not sure what to replace it with. Is there still such a thing as a reference implementation? Perhaps we could link to the HAL section of awesome-embedded-rust instead

@thejpster
Copy link
Contributor

Good question. @jamesmunns can we stick this on the agenda for Tuesday? Personally, I think there should be a reference implementation - perhaps for lm3s811evb or lm3s6965evb emulated by QEMU.

@jamesmunns
Copy link
Member

@thejpster you probably want to ping @therealprof this week, I will likely not be there this week (same with the other issues you tagged).

@no111u3
Copy link
Contributor

no111u3 commented Nov 24, 2019

@thejpster @jamesmunns

Good question. @jamesmunns can we stick this on the agenda for Tuesday? Personally, I think there should be a reference implementation - perhaps for lm3s811evb or lm3s6965evb emulated by QEMU.

I can rewrite this part of examples and remove not common code. Btw now I creating new clean PR for embedded-hal. Thanks

@rubberduck203
Copy link

I noticed this today as well. I went back and found the wg minutes.
This issue was mentioned, but there were no notes on the result of the conversation.
Does anyone remember the result?

https://github.com/rust-embedded/wg/blob/master/minutes/2019-10-29.md

@TheZoq2
Copy link
Author

TheZoq2 commented Jun 18, 2020

Looks like this is even more wrong in the 1.0.0.alpha version since the mentioned f3 crate is stuck at 0.2.0

@eldruin
Copy link
Member

eldruin commented Jun 18, 2020

Linking to #177

@eldruin eldruin added this to the v1.0.0 milestone Jul 15, 2020
@eldruin eldruin added the nominated Issue nominated as discussion topic for the Embedded WG meeting label Sep 16, 2020
bors bot added a commit that referenced this issue Sep 17, 2020
170: Remove unsupported examples for hal r=eldruin a=no111u3

Remove stm32f3 hal implementation as dependency and it's examples from runned doc tests.
Following the #156 

Co-authored-by: Boris Vinogradov <[email protected]>
@eldruin
Copy link
Member

eldruin commented Sep 22, 2020

Now the stm32f3 is used directly. Closing.

@eldruin eldruin closed this as completed Sep 22, 2020
@eldruin
Copy link
Member

eldruin commented Oct 2, 2020

The reference to stm32f30x-hal is still present in the docs. Reopening

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
nominated Issue nominated as discussion topic for the Embedded WG meeting
Projects
None yet
7 participants