diff --git a/common_features.mk b/common_features.mk index eb2ea2811fac..5a1231de4941 100644 --- a/common_features.mk +++ b/common_features.mk @@ -464,7 +464,7 @@ ifneq ($(strip $(BOOTMAGIC_ENABLE)), no) ifeq ($(filter $(BOOTMAGIC_ENABLE),$(VALID_MAGIC_TYPES)),) $(error BOOTMAGIC_ENABLE="$(BOOTMAGIC_ENABLE)" is not a valid type of magic) endif - ifeq ($(strip $(BOOTMAGIC_ENABLE)), lite) + ifneq ($(strip $(BOOTMAGIC_ENABLE)), full) OPT_DEFS += -DBOOTMAGIC_LITE QUANTUM_SRC += $(QUANTUM_DIR)/bootmagic/bootmagic_lite.c else @@ -689,4 +689,4 @@ ifeq ($(strip $(USBPD_ENABLE)), yes) # Board designers can add their own driver to $(SRC) endif endif -endif \ No newline at end of file +endif diff --git a/docs/ChangeLog/20210529/PR12172.md b/docs/ChangeLog/20210529/PR12172.md new file mode 100644 index 000000000000..0c355c151e54 --- /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. diff --git a/layouts/community/ergodox/bocaj/rules.mk b/layouts/community/ergodox/bocaj/rules.mk index 88eaf39f8e86..c6a306fdaa3d 100644 --- a/layouts/community/ergodox/bocaj/rules.mk +++ b/layouts/community/ergodox/bocaj/rules.mk @@ -1,4 +1,4 @@ -BOOTMAGIC_ENABLE = yes +BOOTMAGIC_ENABLE = full TAP_DANCE_ENABLE = no COMMAND_ENABLE = no # Commands for debug and configuration CONSOLE_ENABLE = yes diff --git a/users/gordon/rules.mk b/users/gordon/rules.mk index 19e77b01b1da..06e671a63598 100644 --- a/users/gordon/rules.mk +++ b/users/gordon/rules.mk @@ -1,4 +1,4 @@ TAP_DANCE_ENABLE = yes SRC += gordon.c -# BOOTMAGIC_ENABLE = yes +# BOOTMAGIC_ENABLE = full