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

Prepare for v0.15 release #570

Merged
merged 9 commits into from
Mar 28, 2022
Merged

Conversation

jbeaurivage
Copy link
Contributor

@jbeaurivage jbeaurivage commented Feb 9, 2022

Summary

Prepare for v0.15 release. These are major breaking changes:

  • Strip gpio::v1 and sercom::v1, promote gpio::v2 to gpio and sercom::v2 to sercom.
  • Strip all the #[deprecated] items.
  • Provide the necessary fixes to support those changes

Version numbering

Currently there are two competing opinions on whether we should version this next release as 0.15.0 or as 1.0.0. I'd like to hear your opinions on the matter!

Dependencies

This PR depends on #561, and ideally (but not mandatory) on #569.

Checklist

  • CHANGELOG.md for the BSP or HAL updated
  • All new or modified code is well documented, especially public items
  • No new warnings or clippy suggestions have been introduced (see CI or check locally)

@jbeaurivage jbeaurivage mentioned this pull request Feb 11, 2022
3 tasks
@jbeaurivage jbeaurivage force-pushed the release-v0.15 branch 2 times, most recently from 3008af8 to ab2083e Compare February 14, 2022 21:55
@jbeaurivage jbeaurivage marked this pull request as ready for review February 14, 2022 21:57
@jbeaurivage jbeaurivage force-pushed the release-v0.15 branch 2 times, most recently from bc60ec9 to 6a658a4 Compare February 18, 2022 19:44
@bradleyharden
Copy link
Contributor

Once we get rid of gpio::v1, what do you think about adding aliases to replace the Pa1 types?

type Pa1<M> = Pin<PA01, M>;

Does it hurt to have both PA01 as a PinId and Pa1 as a Pin alias? If not, should we be consistent with leading zeros? Are these aliases even worth it? Or does the bsp_pins! macro take care of most use cases?

@jbeaurivage
Copy link
Contributor Author

Once we get rid of gpio::v1, what do you think about adding aliases to replace the Pa1 types?

type Pa1<M> = Pin<PA01, M>;

Does it hurt to have both PA01 as a PinId and Pa1 as a Pin alias? If not, should we be consistent with leading zeros? Are these aliases even worth it? Or does the bsp_pins! macro take care of most use cases?

@bradleyharden, if I'm being honest, I don't think adding more pin aliases is beneficial. Most people should be using the bsp_pins macro, and seeing as this release will definitely be breaking, it's a good time to only have one way of referring to GPIO pins. IMO, having multiple aliases to the same pin would probably lead to confusion. I remember when the gpio::v2 module came along, it took me a while to understand that Pa1 was now supposed to be called PA01.

@bradleyharden
Copy link
Contributor

Sounds good. It was just an idea I had long ago, but it wasn't feasible then without breaking existing code.

@jbeaurivage jbeaurivage force-pushed the release-v0.15 branch 2 times, most recently from 5ae6517 to 10b79fd Compare February 25, 2022 15:32
@jbeaurivage jbeaurivage force-pushed the release-v0.15 branch 2 times, most recently from 5391ec4 to 53ca475 Compare March 21, 2022 15:50
Copy link
Contributor

@TDHolmes TDHolmes left a comment

Choose a reason for hiding this comment

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

amazing 👏🏼 anything remaining to do here?

hal/README.md Show resolved Hide resolved
boards/samd11_bare/Cargo.toml Show resolved Hide resolved
@jbeaurivage
Copy link
Contributor Author

amazing 👏🏼 anything remaining to do here?

Nope I don't think so, I would merge #569 first though!

@TDHolmes
Copy link
Contributor

merge conflicts now that #569 merged

@TDHolmes TDHolmes merged commit 54cde4c into atsamd-rs:master Mar 28, 2022
@jbeaurivage jbeaurivage deleted the release-v0.15 branch March 28, 2022 16:59
rtsuk pushed a commit to rtsuk/atsamd that referenced this pull request Mar 29, 2022
* Remove gpio::v1 and promote gpio::v2 to gpio

* Remove sercom::v1

* Fix eic modules

* Fix thumbv7em::{pwm, qspi}

* Fix usb modules

* Promote sercom::v2 to sercom

* Fix Tier 1 BSPs

* Remove all deprecated modules

* Adjust HAL readme to point to feather_m0 examples
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants