mirror of
https://github.com/Keychron/qmk_firmware.git
synced 2024-12-26 19:18:03 +06: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
61 lines
2.6 KiB
Makefile
61 lines
2.6 KiB
Makefile
#----------------------------------------------------------------------------
|
|
# On command line:
|
|
#
|
|
# make all = Make software.
|
|
#
|
|
# make clean = Clean out built project files.
|
|
#
|
|
# make coff = Convert ELF to AVR COFF.
|
|
#
|
|
# make extcoff = Convert ELF to AVR Extended COFF.
|
|
#
|
|
# make program = Download the hex file to the device.
|
|
# Please customize your programmer settings(PROGRAM_CMD)
|
|
#
|
|
# make teensy = Download the hex file to the device, using teensy_loader_cli.
|
|
# (must have teensy_loader_cli installed).
|
|
#
|
|
# make dfu = Download the hex file to the device, using dfu-programmer (must
|
|
# have dfu-programmer installed).
|
|
#
|
|
# make flip = Download the hex file to the device, using Atmel FLIP (must
|
|
# have Atmel FLIP installed).
|
|
#
|
|
# make dfu-ee = Download the eeprom file to the device, using dfu-programmer
|
|
# (must have dfu-programmer installed).
|
|
#
|
|
# make flip-ee = Download the eeprom file to the device, using Atmel FLIP
|
|
# (must have Atmel FLIP installed).
|
|
#
|
|
# make debug = Start either simulavr or avarice as specified for debugging,
|
|
# with avr-gdb or avr-insight as the front end for debugging.
|
|
#
|
|
# make filename.s = Just compile filename.c into the assembler code only.
|
|
#
|
|
# make filename.i = Create a preprocessed source file for use in submitting
|
|
# bug reports to the GCC project.
|
|
#
|
|
# To rebuild project do "make clean" then "make all".
|
|
#----------------------------------------------------------------------------
|
|
|
|
# Build Options
|
|
# change to "no" to disable the options, or define them in the makefile.mk in
|
|
# the appropriate keymap folder that will get included automatically
|
|
#
|
|
BOOTMAGIC_ENABLE = no # Enable Bootmagic Lite
|
|
MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
|
|
EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
|
|
CONSOLE_ENABLE = no # Console for debug(+400)
|
|
COMMAND_ENABLE = yes # Commands for debug and configuration
|
|
NKRO_ENABLE = yes # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
|
|
BACKLIGHT_ENABLE = yes # 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 SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
|
|
SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
|
|
|