mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-11-28 06:00:12 +00:00
a03aa301de
* 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
137 lines
4.4 KiB
Makefile
137 lines
4.4 KiB
Makefile
# Build Options
|
|
# change to "no" to disable the options, or define them in the Makefile in
|
|
# the appropriate keymap folder that will get included automatically
|
|
#
|
|
BOOTMAGIC_ENABLE = no # Enable Bootmagic Lite
|
|
MOUSEKEY_ENABLE = no # Mouse keys
|
|
EXTRAKEY_ENABLE = yes # Audio control and System control
|
|
CONSOLE_ENABLE = no # Console for debug
|
|
COMMAND_ENABLE = no # Commands for debug and configuration
|
|
NKRO_ENABLE = no # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
|
|
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
|
|
MIDI_ENABLE = no # MIDI controls
|
|
AUDIO_ENABLE = no # Audio output on port C6
|
|
UNICODE_ENABLE = no # Unicode
|
|
BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
|
|
RGBLIGHT_ENABLE = no # Enable WS2812 RGB underlight. Do not enable this with audio at the same time.
|
|
SWAP_HANDS_ENABLE = no # Enable one-hand typing
|
|
|
|
define ZINC_CUSTOMISE_MSG
|
|
$(info Zinc customize)
|
|
$(info - LED_BACK_ENABLE=$(LED_BACK_ENABLE))
|
|
$(info - LED_UNDERGLOW_ENABLE=$(LED_UNDERGLOW_ENABLE))
|
|
$(info - LED_BOTH_ENABLE=$(LED_BOTH_ENABLE))
|
|
$(info - LED_RGB_CONT=$(LED_RGB_CONT))
|
|
$(info - RGB_MATRIX=$(RGB_MATRIX))
|
|
$(info - LED_ANIMATION=$(LED_ANIMATIONS))
|
|
$(info - IOS_DEVICE_ENABLE=$(IOS_DEVICE_ENABLE))
|
|
endef
|
|
|
|
# Zinc keyboard customize
|
|
LED_BACK_ENABLE = no # LED backlight (Enable SK6812mini backlight)
|
|
LED_UNDERGLOW_ENABLE = no # LED underglow (Enable WS2812 RGB underlight)
|
|
LED_BOTH_ENABLE = no # LED backlight and underglow
|
|
LED_RGB_CONT = no # LED continuous backlight or/and underglow between left Zinc and right Zinc
|
|
RGB_MATRIX = no # RGB LED Matrix
|
|
RGB_MATRIX_SPLIT_RIGHT = no # RGB Matrix for RIGHT Hand
|
|
LED_ANIMATIONS = yes # LED animations
|
|
IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone)
|
|
Link_Time_Optimization = no # if firmware size over limit, try this option
|
|
|
|
#### LED_BACK_ENABLE and LED_UNDERGLOW_ENABLE.
|
|
#### Do not enable these with audio at the same time.
|
|
|
|
### Zinc keyboard 'default' keymap: convenient command line option
|
|
## make ZINC=<options> zinc:defualt
|
|
## option= back | under | both | cont | matrix | na | ios
|
|
## ex.
|
|
## make ZINC=under zinc:defualt
|
|
## make ZINC=under,ios zinc:defualt
|
|
## make ZINC=back zinc:default
|
|
## make ZINC=back,na zinc:default
|
|
## make ZINC=back,ios zinc:default
|
|
|
|
ifneq ($(strip $(ZINC)),)
|
|
ifeq ($(findstring back,$(ZINC)), back)
|
|
LED_BACK_ENABLE = yes
|
|
endif
|
|
ifeq ($(findstring under,$(ZINC)), under)
|
|
LED_UNDERGLOW_ENABLE = yes
|
|
endif
|
|
ifeq ($(findstring both,$(ZINC)), both)
|
|
LED_BOTH_ENABLE = yes
|
|
endif
|
|
ifeq ($(findstring cont,$(ZINC)), cont)
|
|
LED_RGB_CONT = yes
|
|
endif
|
|
ifeq ($(findstring matrix,$(ZINC)), matrix)
|
|
RGB_MATRIX = yes
|
|
endif
|
|
ifeq ($(findstring right,$(ZINC)), right)
|
|
RGB_MATRIX_SPLIT_RIGHT = yes
|
|
endif
|
|
ifeq ($(findstring na,$(ZINC)), na)
|
|
LED_ANIMATIONS = no
|
|
endif
|
|
ifeq ($(findstring ios,$(ZINC)), ios)
|
|
IOS_DEVICE_ENABLE = yes
|
|
endif
|
|
$(eval $(call ZINC_CUSTOMISE_MSG))
|
|
$(info )
|
|
endif
|
|
|
|
ifeq ($(strip $(LED_BACK_ENABLE)), yes)
|
|
RGBLIGHT_ENABLE = yes
|
|
ifeq ($(strip $(LED_UNDERGLOW_ENABLE)), yes)
|
|
OPT_DEFS += -DRGBLED_BOTH
|
|
$(info LED_BOTH_ENABLE option is enabled instead of LED_BACK_ENABLE and LED_UNDERGLOW_ENABLE)
|
|
else
|
|
OPT_DEFS += -DRGBLED_BACK
|
|
endif
|
|
else ifeq ($(strip $(LED_UNDERGLOW_ENABLE)), yes)
|
|
RGBLIGHT_ENABLE = yes
|
|
else
|
|
RGBLIGHT_ENABLE = no
|
|
endif
|
|
|
|
ifeq ($(strip $(LED_BOTH_ENABLE)), yes)
|
|
RGBLIGHT_ENABLE = yes
|
|
OPT_DEFS += -DRGBLED_BOTH
|
|
endif
|
|
|
|
ifeq ($(strip $(LED_RGB_CONT)), yes)
|
|
OPT_DEFS += -DRGBLED_CONT
|
|
endif
|
|
|
|
ifeq ($(strip $(RGB_MATRIX)), yes)
|
|
RGBLIGHT_ENABLE = no
|
|
RGB_MATRIX_ENABLE = yes
|
|
endif
|
|
|
|
ifeq ($(strip $(IOS_DEVICE_ENABLE)), yes)
|
|
OPT_DEFS += -DIOS_DEVICE_ENABLE
|
|
endif
|
|
|
|
ifeq ($(strip $(LED_ANIMATIONS)), yes)
|
|
# OPT_DEFS += -DRGBLIGHT_ANIMATIONS
|
|
OPT_DEFS += -DLED_ANIMATIONS
|
|
|
|
endif
|
|
|
|
ifeq ($(strip $(RGB_MATRIX_SPLIT_RIGHT)), yes)
|
|
OPT_DEFS += -DRGB_MATRIX_SPLIT_RIGHT
|
|
endif
|
|
|
|
ifeq ($(strip $(Link_Time_Optimization)),yes)
|
|
EXTRAFLAGS += -flto -DUSE_Link_Time_Optimization
|
|
endif
|
|
|
|
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
|
|
SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
|
|
|
|
|
|
# Uncomment these for debugging
|
|
# $(info -- RGBLIGHT_ENABLE=$(RGBLIGHT_ENABLE))
|
|
# $(info -- OPT_DEFS=$(OPT_DEFS))
|
|
# $(info )
|