Skip to content

docs: Add warning to changes in board variants in zephyr 4.1 #3298

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

Open
Ndot wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −0
Open

docs: Add warning to changes in board variants in zephyr 4.1 #3298

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/docs/development/local-toolchain/build-flash.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,13 @@ with an onboard MCU or one that uses an MCU board add-on.
</TabItem>
</Tabs>

:::warning
Since Zephyr 4.1 the argument `-b` needs to be set according to the new board
variants. E.g. instead of `planck_rev6` it should be `planck//zmk`. Read more about
Comment on lines +72 to +73
Copy link
Copy Markdown
Contributor

@petejohanson petejohanson Mar 31, 2026

Choose a reason for hiding this comment

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

Suggested change
Since Zephyr 4.1 the argument `-b` needs to be set according to the new board
variants. E.g. instead of `planck_rev6` it should be `planck//zmk`. Read more about
Since moving to Zephyr 4.1, the board IDs for boards in ZMK/Zephyr need include the ZMK board
variants. E.g. instead of `planck_rev6` it should be `planck//zmk`. Read more about

or something like this.

And we should probably fix the -b proton_c a few lines up, while we're at it.

board variants at
[Zephyr 4.1 Update](https://zmk.dev/blog/2025/12/09/zephyr-4-1#zmk-board-variant) blog.
:::

### CMake Arguments

For creating a build system, the `west build` command uses
Expand Down