diff options
author | James Young <18669334+noroadsleft@users.noreply.github.com> | 2021-04-12 12:18:52 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-04-12 21:18:52 +0200 |
commit | a8d64c8b897fc7cb5be372d9580801fd1e4f8a9e (patch) | |
tree | ea550c2a33706ad56085e22f60682f61f8ba45cc /docs | |
parent | f5aaecfdfcfe38b1f2c7504e80150b0df77290d3 (diff) |
Change `BOOTMAGIC_ENABLE=yes` to use Bootmagic Lite (#12172)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/ChangeLog/20210529/PR12172.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/ChangeLog/20210529/PR12172.md b/docs/ChangeLog/20210529/PR12172.md new file mode 100644 index 0000000000..0c355c151e --- /dev/null +++ b/docs/ChangeLog/20210529/PR12172.md @@ -0,0 +1,13 @@ +## Bootmagic Deprecation and Refactor ([#12172](https://github.com/qmk/qmk_firmware/pull/12172)) + +QMK has decided to deprecate the full Bootmagic feature and leave Bootmagic Lite as the only remaining option. + +This pull request changes the behavior of `BOOTMAGIC_ENABLE` such that specifying `BOOTMAGIC_ENABLE = yes` enables Bootmagic Lite instead of full Bootmagic. + +### Tentative Deprecation Schedule + +This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`: + +- From 2021-05-29, setting `BOOTMAGIC_ENABLE = yes` will enable Bootmagic Lite instead of full Bootmagic. +- From 2021-08-28, `BOOTMAGIC_ENABLE` must be either `yes`, `lite`, or `no` – setting `BOOTMAGIC_ENABLE = full` will cause compilation to fail. +- From 2021-11-27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail. |