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

Remove the #[interrupt] macro #1407

Closed
1 of 3 tasks
MabezDev opened this issue Apr 5, 2024 · 3 comments
Closed
1 of 3 tasks

Remove the #[interrupt] macro #1407

MabezDev opened this issue Apr 5, 2024 · 3 comments
Assignees
Labels
status:in-progress This task is currently being worked on

Comments

@MabezDev
Copy link
Member

MabezDev commented Apr 5, 2024

Following up from #1063 we need to:

  • Remove the macro from esp-hal-macros
  • Document how users can still install handlers by default by using #[no_mangle] or #[export_name = ""]
    • Maybe we don't want to document this?
  • Document upgrade paths from #[interrupt] to #[handler]
@MabezDev MabezDev added the status:needs-attention This should be prioritized label Apr 5, 2024
@bjoernQ bjoernQ self-assigned this Apr 8, 2024
@bjoernQ
Copy link
Contributor

bjoernQ commented Apr 8, 2024

Document how users can still install handlers by default by using #[no_mangle] or #[export_name = ""]

Maybe we shouldn't document that. I will most probably just do that in esp-wifi but if users do that for an interrupt which gets taken over by an async driver they might have a bad time debugging that? Explaining all that (and maybe additionally explaining ::interrupt::bind_interrupt) is probably a bit overwhelming for most users and others can figure things out on themselves.

@jessebraham jessebraham added status:in-progress This task is currently being worked on and removed status:needs-attention This should be prioritized labels Apr 8, 2024
@jessebraham
Copy link
Member

#1409 probably closes this? @bjoernQ proposed a migration guide which we can use for the next release, and I think, at least for now, maybe not talking about this potential #[no_mangle]/#[export_name] foot gun is probably for the best 😅

@jessebraham
Copy link
Member

Gonna close this, feel free to re-open if needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:in-progress This task is currently being worked on
Projects
Archived in project
Development

No branches or pull requests

3 participants