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

WIP: feat(boards)!: refactor common layouts #2517

Merged
merged 2 commits into from
Oct 3, 2024

Conversation

joelspadin
Copy link
Collaborator

Removed the combined .dtsi file for each group of common layouts, and split the position map across the files in each group. This makes reading the position maps slightly more difficult, but it aligns the common layouts with the keyboard-specific ones such as foostan/corne.dtsi in that simply including each header adds the layout, with no need to set status = "okay".

Copy link
Contributor

@petejohanson petejohanson left a comment

Choose a reason for hiding this comment

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

Ok, seeing this in practice.... I really do like the fact that boards/shields can just explicitly import the layouts they want and run with it. The splitting up of the position map makes it perhaps a tiny bit harder to grok, but also is cohesive with everything for a given specific layout in the same file. I'd say we go with this, unless @ReFil has any concerns after their initial work on this.

@Nick-Munnich Nick-Munnich added board PRs and issues related to boards. studio ZMK Studio (runtime keymaps) labels Sep 30, 2024
@ReFil
Copy link
Contributor

ReFil commented Oct 1, 2024

I like this implementation, I can foresee it saving a lot of confusion when module developers are unsure whether or not to include status = "okay"; for their specific board

@joelspadin joelspadin marked this pull request as ready for review October 1, 2024 17:55
@joelspadin joelspadin requested a review from a team as a code owner October 1, 2024 17:55
@joelspadin
Copy link
Collaborator Author

I think this is ready for review now. I checked that all the position maps make sense by pasting all the files for each layout together into https://zmk-layout-helper.netlify.app/, but I haven't tested that every board builds yet.

@Nick-Munnich
Copy link
Contributor

Could you split the corne layout as well?

@joelspadin
Copy link
Collaborator Author

Could you split the corne layout as well?

I didn't notice that there were multiple layouts there before. Done.

Removed the combined .dtsi file for each group of common layouts, and
split the position map across the files in each group. This makes
reading the position maps slightly more difficult, but it aligns the
common layouts with the keyboard-specific ones such as
foostan/corne.dtsi in that simply including each header adds the
layout, with no need to set status = "okay".
@joelspadin
Copy link
Collaborator Author

Looks like there are more things for me to update since the commit where I started this branch.

Split up the Corne layout files to match the previous commit.
Copy link
Contributor

@petejohanson petejohanson left a comment

Choose a reason for hiding this comment

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

Thanks!

@petejohanson petejohanson merged commit 60a8f29 into zmkfirmware:main Oct 3, 2024
36 checks passed
joelspadin added a commit to joelspadin/zmk that referenced this pull request Oct 3, 2024
Fixed an issue introduced in zmkfirmware#2517 where the corneish_zen boards weren't
updated. Fixes zmkfirmware#2530.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
board PRs and issues related to boards. studio ZMK Studio (runtime keymaps)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants