diff options
author | James Young <18669334+noroadsleft@users.noreply.github.com> | 2021-08-06 23:59:56 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-08-06 23:59:56 -0700 |
commit | a03aa301def77c867ae6c6c840f7fc82b26d91d6 (patch) | |
tree | a6bc1e2ce769edfd3ce3e25c86ece48d1ca14853 /keyboards/tkc | |
parent | 0bc9090b1f98038b2bf4f648618d6143dcd93c82 (diff) | |
download | qmk_firmware-a03aa301def77c867ae6c6c840f7fc82b26d91d6.tar.gz qmk_firmware-a03aa301def77c867ae6c6c840f7fc82b26d91d6.zip |
Remove Full Bootmagic (#13846)
* disambiguate Bootmagic rules in keymaps
The files edited by this commit were added at a point in time where `BOOTMAGIC_ENABLE = yes` enabled full Bootmagic.
This commit edits the files to specify that full Bootmagic is intended.
* remove BOOTMAGIC_ENABLE=full setting
* unify commented BOOTMAGIC_ENABLE rules in keyboards
Explicitly sets `BOOTMAGIC_ENABLE = no` in keyboards where the rule was commented out.
Command:
```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;#[ \t]*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-zA-Z]\+\).*;\1 = no # Virtual DIP switch configuration;g' {} +
```
* remove commented Bootmagic rules from keymap/user level
Command:
```
find keyboards/ layouts/ users/ -type f -name 'rules.mk' -exec sed -i -e '/#.*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*/d' {} +
```
* update keyboard BOOTMAGIC_ENABLE rule formatting
Sets the formatting of BOOTMAGIC_ENABLE rules to `BOOTMAGIC_ENABLE = [value]`, without the inline comments (which will be replaced later).
Command:
```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
```
* update keyboards' BOOTMAGIC_ENABLE settings
Updates keyboard `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used.
Command:
```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = \)full;\1lite;g' '{}' +
```
* update keymap/user BOOTMAGIC_ENABLE settings
Updates keymap/user `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used.
Commands:
```
find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' +
find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' +
```
* remove and replace inline comments in keyboards and keymap/user files
Removes and replaces the inline comments, which have been updated to read `Enable Bootmagic Lite`.
Commands:
```
find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = lite\);\1 # Enable Bootmagic Lite;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = yes\);\1 # Enable Bootmagic Lite;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = no\);\1 # Enable Bootmagic Lite;g' '{}' +
```
* rename improperly named makefiles
Some files intended to be used as makefiles had improper names causing them to not be used as intended when building.
This commit corrects the filenames of the affected files.
* update renamed file with new rule formatting
* update QMK's template files
Updates QMK's `rules.mk` templates to use the new inline comment.
* update QMK Docs
- remove documentation of full Bootmagic
- update links to Bootmagic Lite doc
- add doc for Magic Keycodes
* rules.mk patch for coarse/ixora and coarse/vinta
Diffstat (limited to 'keyboards/tkc')
-rw-r--r-- | keyboards/tkc/candybar/lefty/rules.mk | 2 | ||||
-rw-r--r-- | keyboards/tkc/candybar/righty/rules.mk | 2 | ||||
-rw-r--r-- | keyboards/tkc/godspeed75/rules.mk | 2 | ||||
-rw-r--r-- | keyboards/tkc/m0lly/rules.mk | 2 | ||||
-rw-r--r-- | keyboards/tkc/osav2/rules.mk | 2 | ||||
-rw-r--r-- | keyboards/tkc/portico/rules.mk | 2 | ||||
-rw-r--r-- | keyboards/tkc/tkc1800/rules.mk | 2 | ||||
-rw-r--r-- | keyboards/tkc/tkl_ab87/rules.mk | 2 |
8 files changed, 8 insertions, 8 deletions
diff --git a/keyboards/tkc/candybar/lefty/rules.mk b/keyboards/tkc/candybar/lefty/rules.mk index 8e05f0643..61f8cc6fa 100644 --- a/keyboards/tkc/candybar/lefty/rules.mk +++ b/keyboards/tkc/candybar/lefty/rules.mk | |||
@@ -10,7 +10,7 @@ BOOTLOADER = stm32-dfu | |||
10 | # EXTRAFLAGS+=-flto | 10 | # EXTRAFLAGS+=-flto |
11 | LTO_ENABLE = yes | 11 | LTO_ENABLE = yes |
12 | BACKLIGHT_ENABLE = no | 12 | BACKLIGHT_ENABLE = no |
13 | BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration | 13 | BOOTMAGIC_ENABLE = lite # Enable Bootmagic Lite |
14 | MOUSEKEY_ENABLE = no # Mouse keys | 14 | MOUSEKEY_ENABLE = no # Mouse keys |
15 | EXTRAKEY_ENABLE = yes # Audio control and System control | 15 | EXTRAKEY_ENABLE = yes # Audio control and System control |
16 | CONSOLE_ENABLE = no # Console for debug | 16 | CONSOLE_ENABLE = no # Console for debug |
diff --git a/keyboards/tkc/candybar/righty/rules.mk b/keyboards/tkc/candybar/righty/rules.mk index 8e05f0643..61f8cc6fa 100644 --- a/keyboards/tkc/candybar/righty/rules.mk +++ b/keyboards/tkc/candybar/righty/rules.mk | |||
@@ -10,7 +10,7 @@ BOOTLOADER = stm32-dfu | |||
10 | # EXTRAFLAGS+=-flto | 10 | # EXTRAFLAGS+=-flto |
11 | LTO_ENABLE = yes | 11 | LTO_ENABLE = yes |
12 | BACKLIGHT_ENABLE = no | 12 | BACKLIGHT_ENABLE = no |
13 | BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration | 13 | BOOTMAGIC_ENABLE = lite # Enable Bootmagic Lite |
14 | MOUSEKEY_ENABLE = no # Mouse keys | 14 | MOUSEKEY_ENABLE = no # Mouse keys |
15 | EXTRAKEY_ENABLE = yes # Audio control and System control | 15 | EXTRAKEY_ENABLE = yes # Audio control and System control |
16 | CONSOLE_ENABLE = no # Console for debug | 16 | CONSOLE_ENABLE = no # Console for debug |
diff --git a/keyboards/tkc/godspeed75/rules.mk b/keyboards/tkc/godspeed75/rules.mk index 12ce2905d..3d67011c6 100644 --- a/keyboards/tkc/godspeed75/rules.mk +++ b/keyboards/tkc/godspeed75/rules.mk | |||
@@ -7,7 +7,7 @@ BOOTLOADER = stm32-dfu | |||
7 | # Build Options | 7 | # Build Options |
8 | # change yes to no to disable | 8 | # change yes to no to disable |
9 | # | 9 | # |
10 | BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration | 10 | BOOTMAGIC_ENABLE = lite # Enable Bootmagic Lite |
11 | MOUSEKEY_ENABLE = yes # Mouse keys | 11 | MOUSEKEY_ENABLE = yes # Mouse keys |
12 | EXTRAKEY_ENABLE = yes # Audio control and System control | 12 | EXTRAKEY_ENABLE = yes # Audio control and System control |
13 | CONSOLE_ENABLE = no # Console for debug | 13 | CONSOLE_ENABLE = no # Console for debug |
diff --git a/keyboards/tkc/m0lly/rules.mk b/keyboards/tkc/m0lly/rules.mk index 01afbdd12..4cfa4e424 100644 --- a/keyboards/tkc/m0lly/rules.mk +++ b/keyboards/tkc/m0lly/rules.mk | |||
@@ -7,7 +7,7 @@ BOOTLOADER = qmk-dfu | |||
7 | # Build Options | 7 | # Build Options |
8 | # change yes to no to disable | 8 | # change yes to no to disable |
9 | # | 9 | # |
10 | BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration | 10 | BOOTMAGIC_ENABLE = lite # Enable Bootmagic Lite |
11 | MOUSEKEY_ENABLE = yes # Mouse keys | 11 | MOUSEKEY_ENABLE = yes # Mouse keys |
12 | EXTRAKEY_ENABLE = yes # Audio control and System control | 12 | EXTRAKEY_ENABLE = yes # Audio control and System control |
13 | CONSOLE_ENABLE = yes # Console for debug | 13 | CONSOLE_ENABLE = yes # Console for debug |
diff --git a/keyboards/tkc/osav2/rules.mk b/keyboards/tkc/osav2/rules.mk index 7185a632c..8da4c4683 100644 --- a/keyboards/tkc/osav2/rules.mk +++ b/keyboards/tkc/osav2/rules.mk | |||
@@ -14,7 +14,7 @@ BOOTLOADER = atmel-dfu | |||
14 | # Build Options | 14 | # Build Options |
15 | # change yes to no to disable | 15 | # change yes to no to disable |
16 | # | 16 | # |
17 | BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration | 17 | BOOTMAGIC_ENABLE = lite # Enable Bootmagic Lite |
18 | MOUSEKEY_ENABLE = no # Mouse keys | 18 | MOUSEKEY_ENABLE = no # Mouse keys |
19 | EXTRAKEY_ENABLE = yes # Audio control and System control | 19 | EXTRAKEY_ENABLE = yes # Audio control and System control |
20 | CONSOLE_ENABLE = yes # Console for debug | 20 | CONSOLE_ENABLE = yes # Console for debug |
diff --git a/keyboards/tkc/portico/rules.mk b/keyboards/tkc/portico/rules.mk index 174938417..44a2a5142 100644 --- a/keyboards/tkc/portico/rules.mk +++ b/keyboards/tkc/portico/rules.mk | |||
@@ -7,7 +7,7 @@ BOOTLOADER = atmel-dfu | |||
7 | # Build Options | 7 | # Build Options |
8 | # change yes to no to disable | 8 | # change yes to no to disable |
9 | # | 9 | # |
10 | BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration | 10 | BOOTMAGIC_ENABLE = lite # Enable Bootmagic Lite |
11 | MOUSEKEY_ENABLE = yes # Mouse keys | 11 | MOUSEKEY_ENABLE = yes # Mouse keys |
12 | EXTRAKEY_ENABLE = yes # Audio control and System control | 12 | EXTRAKEY_ENABLE = yes # Audio control and System control |
13 | CONSOLE_ENABLE = no # Console for debug | 13 | CONSOLE_ENABLE = no # Console for debug |
diff --git a/keyboards/tkc/tkc1800/rules.mk b/keyboards/tkc/tkc1800/rules.mk index fa90e9980..cc5d3676b 100644 --- a/keyboards/tkc/tkc1800/rules.mk +++ b/keyboards/tkc/tkc1800/rules.mk | |||
@@ -15,7 +15,7 @@ BOOTLOADER = qmk-dfu | |||
15 | # change yes to no to disable | 15 | # change yes to no to disable |
16 | # | 16 | # |
17 | 17 | ||
18 | BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration | 18 | BOOTMAGIC_ENABLE = lite # Enable Bootmagic Lite |
19 | MOUSEKEY_ENABLE = yes # Mouse keys | 19 | MOUSEKEY_ENABLE = yes # Mouse keys |
20 | EXTRAKEY_ENABLE = yes # Audio control and System control | 20 | EXTRAKEY_ENABLE = yes # Audio control and System control |
21 | CONSOLE_ENABLE = no # Console for debug | 21 | CONSOLE_ENABLE = no # Console for debug |
diff --git a/keyboards/tkc/tkl_ab87/rules.mk b/keyboards/tkc/tkl_ab87/rules.mk index 1d60cf3c2..a7eaf89e1 100644 --- a/keyboards/tkc/tkl_ab87/rules.mk +++ b/keyboards/tkc/tkl_ab87/rules.mk | |||
@@ -7,7 +7,7 @@ BOOTLOADER = atmel-dfu | |||
7 | # Build Options | 7 | # Build Options |
8 | # change yes to no to disable | 8 | # change yes to no to disable |
9 | # | 9 | # |
10 | BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration | 10 | BOOTMAGIC_ENABLE = lite # Enable Bootmagic Lite |
11 | MOUSEKEY_ENABLE = yes # Mouse keys | 11 | MOUSEKEY_ENABLE = yes # Mouse keys |
12 | EXTRAKEY_ENABLE = yes # Audio control and System control | 12 | EXTRAKEY_ENABLE = yes # Audio control and System control |
13 | CONSOLE_ENABLE = no # Console for debug | 13 | CONSOLE_ENABLE = no # Console for debug |