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/kingly_keys | |
| 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/kingly_keys')
| -rw-r--r-- | keyboards/kingly_keys/ave/ortho/rules.mk | 2 | ||||
| -rw-r--r-- | keyboards/kingly_keys/ave/staggered/rules.mk | 2 | ||||
| -rw-r--r-- | keyboards/kingly_keys/little_foot/rules.mk | 2 | ||||
| -rw-r--r-- | keyboards/kingly_keys/romac/rules.mk | 2 | ||||
| -rw-r--r-- | keyboards/kingly_keys/romac_plus/rules.mk | 2 | ||||
| -rw-r--r-- | keyboards/kingly_keys/ropro/rules.mk | 2 | ||||
| -rw-r--r-- | keyboards/kingly_keys/smd_milk/rules.mk | 2 | ||||
| -rw-r--r-- | keyboards/kingly_keys/soap/rules.mk | 2 |
8 files changed, 8 insertions, 8 deletions
diff --git a/keyboards/kingly_keys/ave/ortho/rules.mk b/keyboards/kingly_keys/ave/ortho/rules.mk index 611eb0ce1..e3ccc9fea 100644 --- a/keyboards/kingly_keys/ave/ortho/rules.mk +++ b/keyboards/kingly_keys/ave/ortho/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/kingly_keys/ave/staggered/rules.mk b/keyboards/kingly_keys/ave/staggered/rules.mk index 611eb0ce1..e3ccc9fea 100644 --- a/keyboards/kingly_keys/ave/staggered/rules.mk +++ b/keyboards/kingly_keys/ave/staggered/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/kingly_keys/little_foot/rules.mk b/keyboards/kingly_keys/little_foot/rules.mk index c314b98dd..bd5990ab5 100644 --- a/keyboards/kingly_keys/little_foot/rules.mk +++ b/keyboards/kingly_keys/little_foot/rules.mk | |||
| @@ -14,7 +14,7 @@ BOOTLOADER = caterina | |||
| 14 | # Build Options | 14 | # Build Options |
| 15 | # comment out to disable the options. | 15 | # comment out to disable the options. |
| 16 | # | 16 | # |
| 17 | BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration | 17 | BOOTMAGIC_ENABLE = lite # Enable Bootmagic Lite |
| 18 | MOUSEKEY_ENABLE = yes # Mouse keys | 18 | MOUSEKEY_ENABLE = yes # Mouse keys |
| 19 | EXTRAKEY_ENABLE = yes # Audio control and System control | 19 | EXTRAKEY_ENABLE = yes # Audio control and System control |
| 20 | CONSOLE_ENABLE = no # Console for debug | 20 | CONSOLE_ENABLE = no # Console for debug |
diff --git a/keyboards/kingly_keys/romac/rules.mk b/keyboards/kingly_keys/romac/rules.mk index 9bd22f18b..81c1b5e03 100644 --- a/keyboards/kingly_keys/romac/rules.mk +++ b/keyboards/kingly_keys/romac/rules.mk | |||
| @@ -14,7 +14,7 @@ BOOTLOADER = caterina | |||
| 14 | # Build Options | 14 | # Build Options |
| 15 | # comment out to disable the options. | 15 | # comment out to disable the options. |
| 16 | # | 16 | # |
| 17 | BOOTMAGIC_ENABLE = full # Virtual DIP switch configuration | 17 | BOOTMAGIC_ENABLE = lite # Enable Bootmagic Lite |
| 18 | MOUSEKEY_ENABLE = yes # Mouse keys | 18 | MOUSEKEY_ENABLE = yes # Mouse keys |
| 19 | EXTRAKEY_ENABLE = yes # Audio control and System control | 19 | EXTRAKEY_ENABLE = yes # Audio control and System control |
| 20 | CONSOLE_ENABLE = no # Console for debug | 20 | CONSOLE_ENABLE = no # Console for debug |
diff --git a/keyboards/kingly_keys/romac_plus/rules.mk b/keyboards/kingly_keys/romac_plus/rules.mk index 806b6355b..14be02a3c 100644 --- a/keyboards/kingly_keys/romac_plus/rules.mk +++ b/keyboards/kingly_keys/romac_plus/rules.mk | |||
| @@ -14,7 +14,7 @@ BOOTLOADER = caterina | |||
| 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 = yes # Mouse keys | 18 | MOUSEKEY_ENABLE = yes # Mouse keys |
| 19 | EXTRAKEY_ENABLE = yes # Audio control and System control | 19 | EXTRAKEY_ENABLE = yes # Audio control and System control |
| 20 | # Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE | 20 | # Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE |
diff --git a/keyboards/kingly_keys/ropro/rules.mk b/keyboards/kingly_keys/ropro/rules.mk index a8cce7780..6a62451dd 100644 --- a/keyboards/kingly_keys/ropro/rules.mk +++ b/keyboards/kingly_keys/ropro/rules.mk | |||
| @@ -14,7 +14,7 @@ BOOTLOADER = caterina | |||
| 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 = full # Virtual DIP switch configuration | 17 | BOOTMAGIC_ENABLE = lite # Enable Bootmagic Lite |
| 18 | MOUSEKEY_ENABLE = yes # Mouse keys | 18 | MOUSEKEY_ENABLE = yes # Mouse keys |
| 19 | EXTRAKEY_ENABLE = yes # Audio control and System control | 19 | EXTRAKEY_ENABLE = yes # Audio control and System control |
| 20 | CONSOLE_ENABLE = no # Console for debug | 20 | CONSOLE_ENABLE = no # Console for debug |
diff --git a/keyboards/kingly_keys/smd_milk/rules.mk b/keyboards/kingly_keys/smd_milk/rules.mk index f34f8891b..8ea4fb638 100644 --- a/keyboards/kingly_keys/smd_milk/rules.mk +++ b/keyboards/kingly_keys/smd_milk/rules.mk | |||
| @@ -14,7 +14,7 @@ BOOTLOADER = atmel-dfu | |||
| 14 | # Build Options | 14 | # Build Options |
| 15 | # comment out to disable the options. | 15 | # comment out to disable the options. |
| 16 | # | 16 | # |
| 17 | BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration | 17 | BOOTMAGIC_ENABLE = no # Enable Bootmagic Lite |
| 18 | MOUSEKEY_ENABLE = no # Mouse keys | 18 | MOUSEKEY_ENABLE = no # Mouse keys |
| 19 | EXTRAKEY_ENABLE = no # Audio control and System control | 19 | EXTRAKEY_ENABLE = no # Audio control and System control |
| 20 | CONSOLE_ENABLE = yes # Console for debug | 20 | CONSOLE_ENABLE = yes # Console for debug |
diff --git a/keyboards/kingly_keys/soap/rules.mk b/keyboards/kingly_keys/soap/rules.mk index e6d997bfe..0b0272fbd 100644 --- a/keyboards/kingly_keys/soap/rules.mk +++ b/keyboards/kingly_keys/soap/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 = full # Virtual DIP switch configuration | 17 | BOOTMAGIC_ENABLE = lite # Enable Bootmagic Lite |
| 18 | MOUSEKEY_ENABLE = yes # Mouse keys | 18 | MOUSEKEY_ENABLE = yes # Mouse keys |
| 19 | EXTRAKEY_ENABLE = yes # Audio control and System control | 19 | EXTRAKEY_ENABLE = yes # Audio control and System control |
| 20 | CONSOLE_ENABLE = no # Console for debug | 20 | CONSOLE_ENABLE = no # Console for debug |
