Skip to content

Commit

Permalink
Change BOOTMAGIC_ENABLE=yes to use Bootmagic Lite (qmk#12172)
Browse files Browse the repository at this point in the history
  • Loading branch information
noroadsleft authored Apr 12, 2021
1 parent af7d05e commit b084fde
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 4 deletions.
4 changes: 2 additions & 2 deletions common_features.mk
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -689,4 +689,4 @@ ifeq ($(strip $(USBPD_ENABLE)), yes)
# Board designers can add their own driver to $(SRC)
endif
endif
endif
endif
13 changes: 13 additions & 0 deletions docs/ChangeLog/20210529/PR12172.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion layouts/community/ergodox/bocaj/rules.mk
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion users/gordon/rules.mk
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
TAP_DANCE_ENABLE = yes
SRC += gordon.c

# BOOTMAGIC_ENABLE = yes
# BOOTMAGIC_ENABLE = full

0 comments on commit b084fde

Please sign in to comment.