From f421fe9f2c3db237094354f2fba4637cb7510459 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Tue, 18 May 2021 12:51:57 -0700 Subject: [PATCH 01/16] Add ChangeLog for 2021-05-29 Breaking Changes Merge: initial version --- docs/ChangeLog/20210529.md | 117 +++++++++++++++++++++++++++++++++++++ 1 file changed, 117 insertions(+) create mode 100644 docs/ChangeLog/20210529.md diff --git a/docs/ChangeLog/20210529.md b/docs/ChangeLog/20210529.md new file mode 100644 index 000000000000..639cedc3e477 --- /dev/null +++ b/docs/ChangeLog/20210529.md @@ -0,0 +1,117 @@ +# QMK Breaking Changes - 2021 May 29 Changelog + + +## Changes Requiring User Action + + +## Core Changes + + +### ChibiOS Update and Config Migration + + +### QMK Infrastructure and Internals + + +## Detailed Change List + + +### Changes Requiring User Action + +* Durgod keyboard refactor in preparation for adding additional durgod keyboards ([#11978](https://github.com/qmk/qmk_firmware/pull/11978)) +* Change `BOOTMAGIC_ENABLE=yes` to use Bootmagic Lite ([#12172](https://github.com/qmk/qmk_firmware/pull/12172)) +* Updated Function96 with V2 files and removed chconf.h and halconf.h ([#12613](https://github.com/qmk/qmk_firmware/pull/12613)) +* [Keyboard] updated a vendor name / fixed minor keymap issues ([#12881](https://github.com/qmk/qmk_firmware/pull/12881)) + +### Fixes + +* Fix connection issue in split keyboards when slave and OLED display are connected via I2C (fixes #9335) ([#11487](https://github.com/qmk/qmk_firmware/pull/11487)) +* Terrazzo: Fix wrong LED Matrix function names ([#12561](https://github.com/qmk/qmk_firmware/pull/12561)) +* Apply the "NO_LIMITED_CONTROLLER_CONNECT" fix to atmega16u2 ([#12482](https://github.com/qmk/qmk_firmware/pull/12482)) +* Fix comment parsing ([#12750](https://github.com/qmk/qmk_firmware/pull/12750)) +* Turn OLED off on suspend in soundmonster Corne keymap ([#10419](https://github.com/qmk/qmk_firmware/pull/10419)) +* Fixup build errors on `develop` branch. ([#12723](https://github.com/qmk/qmk_firmware/pull/12723)) +* Fix syntax error when compiling for ARM ([#12866](https://github.com/qmk/qmk_firmware/pull/12866)) +* Add missing LED Matrix suspend code to suspend.c ([#12878](https://github.com/qmk/qmk_firmware/pull/12878)) +* Fix spelling mistake regarding LED Matrix in split_common. ([#12888](https://github.com/qmk/qmk_firmware/pull/12888)) +* [Keymap] Fix QWERTY/DVORAK status output for kzar keymap ([#12895](https://github.com/qmk/qmk_firmware/pull/12895)) +* Fixup housekeeping from being invoked twice per loop. ([#12933](https://github.com/qmk/qmk_firmware/pull/12933)) + +### Additions and Enhancements + +* ARM - Refactor SLEEP_LED to support more platforms ([#8403](https://github.com/qmk/qmk_firmware/pull/8403)) +* Add ability to toggle One Shot functionality ([#4198](https://github.com/qmk/qmk_firmware/pull/4198)) +* Add RGB Matrix support to Split Common ([#11055](https://github.com/qmk/qmk_firmware/pull/11055)) +* Add support for complementary outputs to the ChibiOS WS2812 PWM driver ([#11988](https://github.com/qmk/qmk_firmware/pull/11988)) +* Enable RGB Matrix for Corne ([#12091](https://github.com/qmk/qmk_firmware/pull/12091)) +* Set default OLED Update Interval for Split Keyboards to improve matrix scan performance ([#12107](https://github.com/qmk/qmk_firmware/pull/12107)) +* Add support for MK66F18 (Teensy 3.6) micro controller ([#12258](https://github.com/qmk/qmk_firmware/pull/12258)) +* Split RGB Matrix support for RGBKB Zygomorph ([#11083](https://github.com/qmk/qmk_firmware/pull/11083)) +* Add baudrate and circular buffer to ARM WS2812 SPI config ([#12216](https://github.com/qmk/qmk_firmware/pull/12216)) +* Add keyboard level weak function for slave matrix scan ([#12317](https://github.com/qmk/qmk_firmware/pull/12317)) +* Add link to schematic on EasyEDA for XD60 ([#12018](https://github.com/qmk/qmk_firmware/pull/12018)) +* Add Config functions for LED Matrix ([#12361](https://github.com/qmk/qmk_firmware/pull/12361)) +* Add pin definitions for MK66F18 ([#12419](https://github.com/qmk/qmk_firmware/pull/12419)) +* add kinesis/kint36 keyboard ([#10171](https://github.com/qmk/qmk_firmware/pull/10171)) +* Add support for producing UF2-format binaries. ([#12435](https://github.com/qmk/qmk_firmware/pull/12435)) +* Implement CIE1931 curve for LED Matrix ([#12417](https://github.com/qmk/qmk_firmware/pull/12417)) +* Add kzar keymap for Kinesis Advantage ([#12444](https://github.com/qmk/qmk_firmware/pull/12444)) +* LED Matrix: suspend code ([#12509](https://github.com/qmk/qmk_firmware/pull/12509)) +* LED Matrix: Task system ([#12580](https://github.com/qmk/qmk_firmware/pull/12580)) +* Add missing RGB_MODE_TWINKLE / RGB_M_TW keycodes ([#11935](https://github.com/qmk/qmk_firmware/pull/11935)) +* Enhancement of WPM feature ([#11727](https://github.com/qmk/qmk_firmware/pull/11727)) +* Add Per Key functionality for AutoShift ([#11536](https://github.com/qmk/qmk_firmware/pull/11536)) +* LED Matrix: Reactive effect buffers & advanced indicators ([#12588](https://github.com/qmk/qmk_firmware/pull/12588)) +* LED Matrix: support for Split keyboards ([#12633](https://github.com/qmk/qmk_firmware/pull/12633)) +* add setting to enable infinite timeout for leader key ([#6580](https://github.com/qmk/qmk_firmware/pull/6580), [#12721](https://github.com/qmk/qmk_firmware/pull/12721 "Fix bad PR merge for #6580")) +* Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx ([#12403](https://github.com/qmk/qmk_firmware/pull/12403)) +* Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) ([#12600](https://github.com/qmk/qmk_firmware/pull/12600)) +* Add support for STM32F446 MCU ([#12619](https://github.com/qmk/qmk_firmware/pull/12619)) +* Add STM32L433 and L443 support ([#12063](https://github.com/qmk/qmk_firmware/pull/12063)) +* Added OLED fade out support ([#12086](https://github.com/qmk/qmk_firmware/pull/12086)) +* New command: `qmk console` ([#12828](https://github.com/qmk/qmk_firmware/pull/12828)) +* LED Matrix: Effects! ([#12651](https://github.com/qmk/qmk_firmware/pull/12651)) +* Add setup, clone, and env to the list of commands we allow even with broken modules ([#12868](https://github.com/qmk/qmk_firmware/pull/12868)) +* LED Matrix: Documentation ([#12685](https://github.com/qmk/qmk_firmware/pull/12685)) +* Add function to allow repeated blinking of one layer ([#12237](https://github.com/qmk/qmk_firmware/pull/12237)) + +### Clean-ups and Optimizations + +* Overhaul bootmagic logic to have single entrypoint ([#8532](https://github.com/qmk/qmk_firmware/pull/8532)) +* Refactor of USB code within split_common ([#11890](https://github.com/qmk/qmk_firmware/pull/11890)) +* Begin the process of deprecating `bin/qmk` in favor of the global CLI ([#12109](https://github.com/qmk/qmk_firmware/pull/12109)) +* LED Matrix: decouple from Backlight ([#12054](https://github.com/qmk/qmk_firmware/pull/12054)) +* Remove `FUNC()` ([#12161](https://github.com/qmk/qmk_firmware/pull/12161)) +* Move gpio wait logic to wait.h ([#12067](https://github.com/qmk/qmk_firmware/pull/12067)) +* LED Matrix: Clean up includes ([#12197](https://github.com/qmk/qmk_firmware/pull/12197)) +* Consistently use bin/qmk when that script is called ([#12286](https://github.com/qmk/qmk_firmware/pull/12286)) +* LED Matrix: Additional common_features.mk tweaks ([#12187](https://github.com/qmk/qmk_firmware/pull/12187)) +* LED Matrix: Fix up eeconfig code ([#12327](https://github.com/qmk/qmk_firmware/pull/12327)) +* Big quantum_keycodes cleanup ([#12249](https://github.com/qmk/qmk_firmware/pull/12249)) +* Fix up builds that are now too big for `develop` branch. ([#12495](https://github.com/qmk/qmk_firmware/pull/12495)) +* [Keyboard] kint36: switch to sym_eager_pk debouncing ([#12626](https://github.com/qmk/qmk_firmware/pull/12626)) +* [Keyboard] kint2pp: reduce input latency by ≈10ms ([#12625](https://github.com/qmk/qmk_firmware/pull/12625)) +* eeprom driver: Refactor where eeprom driver initialisation (and EEPROM emulation initialisation) occurs to make it non-target-specific. ([#12671](https://github.com/qmk/qmk_firmware/pull/12671)) +* Change RGB/LED Matrix to use a simple define for USB suspend ([#12697](https://github.com/qmk/qmk_firmware/pull/12697), [#12770](https://github.com/qmk/qmk_firmware/pull/12770 "Fixing transport's led/rgb matrix suspend state logic")) +* Remove pointless SERIAL_LINK_ENABLE rules ([#12846](https://github.com/qmk/qmk_firmware/pull/12846)) +* Make Swap Hands use PROGMEM ([#12284](https://github.com/qmk/qmk_firmware/pull/12284)) +* Remove KEYMAP and LAYOUT_kc ([#12160](https://github.com/qmk/qmk_firmware/pull/12160)) +* Rename `point_t` -> `led_point_t` ([#12864](https://github.com/qmk/qmk_firmware/pull/12864)) +* Deprecate `send_unicode_hex_string()` ([#12602](https://github.com/qmk/qmk_firmware/pull/12602)) + +### QMK Infrastructure and Internals + +* trivial change to trigger api update ([`b15288fb87`](https://github.com/qmk/qmk_firmware/commit/b15288fb87)) +* fix some references to bin/qmk that slipped in ([#12832](https://github.com/qmk/qmk_firmware/pull/12832)) +* Resolve a number of warnings in `qmk generate-api` ([#12833](https://github.com/qmk/qmk_firmware/pull/12833)) +* Fix another bin/qmk reference ([#12856](https://github.com/qmk/qmk_firmware/pull/12856)) +* Use milc.subcommand.config instead of qmk.cli.config ([#12915](https://github.com/qmk/qmk_firmware/pull/12915)) + +### ChibiOS Update and Config Migration + + +---- + +* Branch point for 2021 May 29 Breaking Change ([`c7a7982e23`](https://github.com/qmk/qmk_firmware/commit/c7a7982e23)) + +PR List last updated: 2021-05-18 12:12:49 -0700 From 2d8bc59db6d2ef341db172d5b34af3c8ad4a6b2a Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Thu, 27 May 2021 10:18:29 -0700 Subject: [PATCH 02/16] Add recent develop changes --- docs/ChangeLog/20210529.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/ChangeLog/20210529.md b/docs/ChangeLog/20210529.md index 639cedc3e477..46ca05bd48fa 100644 --- a/docs/ChangeLog/20210529.md +++ b/docs/ChangeLog/20210529.md @@ -114,4 +114,17 @@ * Branch point for 2021 May 29 Breaking Change ([`c7a7982e23`](https://github.com/qmk/qmk_firmware/commit/c7a7982e23)) -PR List last updated: 2021-05-18 12:12:49 -0700 +PR List last updated: 2021-05-27 09:09:34 -07:00 + +- 82aa9ad4a5 matrix: wait for row signal to go HIGH for every row (#12945) +- 4c0d8ae8d7 ensure we do not conflict with existing keymap aliases (#12976) +- 8e96c5a060 Add support for up to 4 IS31FL3733 drivers (#12342) +- a0fed0ea17 Convert Encoder callbacks to be boolean functions (#12805) +- 8f4767d966 [Keyboard] Fix Terrazzo build failure (#12977) +- 330fe1d1cc Do not hard set config in CPTC files (#11864) +- 57158cc3bc [Keyboard] Corne - Remove legacy revision support (#12226) +- f461adbd1d [Keymap] Update to Drashna keymap and user code (based on develop) (#12936) +- d9610120de Add Full-duplex serial driver for ARM boards (#9842) +- ebaba80287 Document LED_MATRIX_FRAMEBUFFER_EFFECTS (#12987) +- 06aea834c4 Backlight: add defines for default level and breathing state (#12560) +- b769b36202 Add dire message about LUFA mass storage bootloader (#13014) From c26534734ba26782d53c28f52622947e1c078dcc Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Thu, 27 May 2021 17:02:22 -0700 Subject: [PATCH 03/16] Sort recent develop changes --- docs/ChangeLog/20210529.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/ChangeLog/20210529.md b/docs/ChangeLog/20210529.md index 46ca05bd48fa..e32f9128df43 100644 --- a/docs/ChangeLog/20210529.md +++ b/docs/ChangeLog/20210529.md @@ -22,6 +22,7 @@ * Change `BOOTMAGIC_ENABLE=yes` to use Bootmagic Lite ([#12172](https://github.com/qmk/qmk_firmware/pull/12172)) * Updated Function96 with V2 files and removed chconf.h and halconf.h ([#12613](https://github.com/qmk/qmk_firmware/pull/12613)) * [Keyboard] updated a vendor name / fixed minor keymap issues ([#12881](https://github.com/qmk/qmk_firmware/pull/12881)) +* [Keyboard] Corne - Remove legacy revision support ([#12226](https://github.com/qmk/qmk_firmware/pull/12226)) ### Fixes @@ -36,6 +37,10 @@ * Fix spelling mistake regarding LED Matrix in split_common. ([#12888](https://github.com/qmk/qmk_firmware/pull/12888)) * [Keymap] Fix QWERTY/DVORAK status output for kzar keymap ([#12895](https://github.com/qmk/qmk_firmware/pull/12895)) * Fixup housekeeping from being invoked twice per loop. ([#12933](https://github.com/qmk/qmk_firmware/pull/12933)) +* wait for matrix row signal to go HIGH for every row ([#12945](https://github.com/qmk/qmk_firmware/pull/12945)) +* ensure we do not conflict with existing keymap aliases ([#12976](https://github.com/qmk/qmk_firmware/pull/12976)) +* [Keyboard] Fix Terrazzo build failure ([#12977](https://github.com/qmk/qmk_firmware/pull/12977)) +* Do not hard set config in CPTC files ([#11864](https://github.com/qmk/qmk_firmware/pull/11864)) ### Additions and Enhancements @@ -74,6 +79,13 @@ * Add setup, clone, and env to the list of commands we allow even with broken modules ([#12868](https://github.com/qmk/qmk_firmware/pull/12868)) * LED Matrix: Documentation ([#12685](https://github.com/qmk/qmk_firmware/pull/12685)) * Add function to allow repeated blinking of one layer ([#12237](https://github.com/qmk/qmk_firmware/pull/12237)) +* Add support for up to 4 IS31FL3733 drivers ([#12342](https://github.com/qmk/qmk_firmware/pull/12342)) +* Convert Encoder callbacks to be boolean functions ([#12805](https://github.com/qmk/qmk_firmware/pull/12805)) +* [Keymap] Update to Drashna keymap and user code (based on develop) ([#12936](https://github.com/qmk/qmk_firmware/pull/12936)) +* Add Full-duplex serial driver for ARM boards ([#9842](https://github.com/qmk/qmk_firmware/pull/9842)) +* Document LED_MATRIX_FRAMEBUFFER_EFFECTS ([#12987](https://github.com/qmk/qmk_firmware/pull/12987)) +* Backlight: add defines for default level and breathing state ([#12560](https://github.com/qmk/qmk_firmware/pull/12560)) +* Add dire message about LUFA mass storage bootloader ([#13014](https://github.com/qmk/qmk_firmware/pull/13014)) ### Clean-ups and Optimizations @@ -115,16 +127,3 @@ * Branch point for 2021 May 29 Breaking Change ([`c7a7982e23`](https://github.com/qmk/qmk_firmware/commit/c7a7982e23)) PR List last updated: 2021-05-27 09:09:34 -07:00 - -- 82aa9ad4a5 matrix: wait for row signal to go HIGH for every row (#12945) -- 4c0d8ae8d7 ensure we do not conflict with existing keymap aliases (#12976) -- 8e96c5a060 Add support for up to 4 IS31FL3733 drivers (#12342) -- a0fed0ea17 Convert Encoder callbacks to be boolean functions (#12805) -- 8f4767d966 [Keyboard] Fix Terrazzo build failure (#12977) -- 330fe1d1cc Do not hard set config in CPTC files (#11864) -- 57158cc3bc [Keyboard] Corne - Remove legacy revision support (#12226) -- f461adbd1d [Keymap] Update to Drashna keymap and user code (based on develop) (#12936) -- d9610120de Add Full-duplex serial driver for ARM boards (#9842) -- ebaba80287 Document LED_MATRIX_FRAMEBUFFER_EFFECTS (#12987) -- 06aea834c4 Backlight: add defines for default level and breathing state (#12560) -- b769b36202 Add dire message about LUFA mass storage bootloader (#13014) From c8f22b666b06e94bb8927e70c5f94e12d07b536f Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Thu, 27 May 2021 23:11:50 -0700 Subject: [PATCH 04/16] Remove sections for ChibiOS changes per tzarc No ChibiOS changes this round. --- docs/ChangeLog/20210529.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/ChangeLog/20210529.md b/docs/ChangeLog/20210529.md index e32f9128df43..bdcf00968421 100644 --- a/docs/ChangeLog/20210529.md +++ b/docs/ChangeLog/20210529.md @@ -7,9 +7,6 @@ ## Core Changes -### ChibiOS Update and Config Migration - - ### QMK Infrastructure and Internals @@ -119,8 +116,6 @@ * Fix another bin/qmk reference ([#12856](https://github.com/qmk/qmk_firmware/pull/12856)) * Use milc.subcommand.config instead of qmk.cli.config ([#12915](https://github.com/qmk/qmk_firmware/pull/12915)) -### ChibiOS Update and Config Migration - ---- From 69c1240ff78d5890765c35bd01f2300c591992e3 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Thu, 27 May 2021 23:19:09 -0700 Subject: [PATCH 05/16] Add and sort recent develop changes --- docs/ChangeLog/20210529.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/ChangeLog/20210529.md b/docs/ChangeLog/20210529.md index bdcf00968421..8aaede9e355c 100644 --- a/docs/ChangeLog/20210529.md +++ b/docs/ChangeLog/20210529.md @@ -38,6 +38,7 @@ * ensure we do not conflict with existing keymap aliases ([#12976](https://github.com/qmk/qmk_firmware/pull/12976)) * [Keyboard] Fix Terrazzo build failure ([#12977](https://github.com/qmk/qmk_firmware/pull/12977)) * Do not hard set config in CPTC files ([#11864](https://github.com/qmk/qmk_firmware/pull/11864)) +* Fix keyboards/keymaps for boolean encoder callback changes ([#12985](https://github.com/qmk/qmk_firmware/pull/12985)) ### Additions and Enhancements @@ -107,6 +108,7 @@ * Remove KEYMAP and LAYOUT_kc ([#12160](https://github.com/qmk/qmk_firmware/pull/12160)) * Rename `point_t` -> `led_point_t` ([#12864](https://github.com/qmk/qmk_firmware/pull/12864)) * Deprecate `send_unicode_hex_string()` ([#12602](https://github.com/qmk/qmk_firmware/pull/12602)) +* [Keyboard] Remove redundant legacy and common headers for crkbd ([#13023](https://github.com/qmk/qmk_firmware/pull/13023)) ### QMK Infrastructure and Internals @@ -121,4 +123,4 @@ * Branch point for 2021 May 29 Breaking Change ([`c7a7982e23`](https://github.com/qmk/qmk_firmware/commit/c7a7982e23)) -PR List last updated: 2021-05-27 09:09:34 -07:00 +PR List last updated: 2021-05-27 23:11:20 -07:00 From cb50f6618de4f7015dc8a7eb2bf936dcff71de55 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sat, 29 May 2021 04:05:46 -0700 Subject: [PATCH 06/16] add notes about keyboard moves/deletions --- docs/ChangeLog/20210529.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/ChangeLog/20210529.md b/docs/ChangeLog/20210529.md index 8aaede9e355c..5a0439f87302 100644 --- a/docs/ChangeLog/20210529.md +++ b/docs/ChangeLog/20210529.md @@ -3,6 +3,24 @@ ## Changes Requiring User Action +The following keyboards have had their source moved within QMK: + +Old Keyboard Name | New Keyboard Name +:---------------- | :---------------- +crkbd/rev1/common | crkbd/rev1 +function96 | function96/v1 +nckiibs/flatbread60 | delikeeb/flatbread60 +nckiibs/vaguettelite | delikeeb/vaguettelite +nckiibs/vanana/rev1 | delikeeb/vanana/rev1 +nckiibs/vanana/rev2 | delikeeb/vanana/rev2 +nckiibs/vaneela | delikeeb/vaneela +nckiibs/vaneelaex | delikeeb/vaneelaex +nckiibs/waaffle/rev3/elite_c | delikeeb/waaffle/rev3/elite_c +nckiibs/waaffle/rev3/pro_micro | delikeeb/waaffle/rev3/pro_micro + +The [Function96 V2](https://github.com/qmk/qmk_firmware/tree/0.13.0/keyboards/function96/v2) has also been added as part of these changes. + +Additionally, the `crkbd/rev1/legacy` keyboard has been removed. ## Core Changes From 3019eac2668f889b18502b0d1a0ea3627b600edb Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sat, 29 May 2021 09:50:04 -0700 Subject: [PATCH 07/16] import changelog for PR 12172 Documents the change to BOOTMAGIC_ENABLE. --- docs/ChangeLog/20210529.md | 13 +++++++++++-- docs/ChangeLog/20210529/PR12172.md | 13 ------------- 2 files changed, 11 insertions(+), 15 deletions(-) delete mode 100644 docs/ChangeLog/20210529/PR12172.md diff --git a/docs/ChangeLog/20210529.md b/docs/ChangeLog/20210529.md index 5a0439f87302..c911f81bfec6 100644 --- a/docs/ChangeLog/20210529.md +++ b/docs/ChangeLog/20210529.md @@ -22,10 +22,19 @@ The [Function96 V2](https://github.com/qmk/qmk_firmware/tree/0.13.0/keyboards/fu Additionally, the `crkbd/rev1/legacy` keyboard has been removed. -## Core Changes +### 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. -### QMK Infrastructure and Internals +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 May 29, setting `BOOTMAGIC_ENABLE = yes` will enable Bootmagic Lite instead of full Bootmagic. +- From 2021 Aug 28, `BOOTMAGIC_ENABLE` must be either `yes`, `lite`, or `no` – setting `BOOTMAGIC_ENABLE = full` will cause compilation to fail. +- From 2021 Nov 27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail. ## Detailed Change List diff --git a/docs/ChangeLog/20210529/PR12172.md b/docs/ChangeLog/20210529/PR12172.md deleted file mode 100644 index 0c355c151e54..000000000000 --- a/docs/ChangeLog/20210529/PR12172.md +++ /dev/null @@ -1,13 +0,0 @@ -## 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. From f6697ec3d507c969bac34f9b323047d8608b96f6 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sat, 29 May 2021 10:15:23 -0700 Subject: [PATCH 08/16] update section headings --- docs/ChangeLog/20210529.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/ChangeLog/20210529.md b/docs/ChangeLog/20210529.md index c911f81bfec6..1582df84f377 100644 --- a/docs/ChangeLog/20210529.md +++ b/docs/ChangeLog/20210529.md @@ -1,7 +1,9 @@ # QMK Breaking Changes - 2021 May 29 Changelog -## Changes Requiring User Action +## Changes Requiring User Action :id=changes-requiring-user-action + +### Relocated Keyboards :id=relocated-keyboards The following keyboards have had their source moved within QMK: @@ -22,7 +24,7 @@ The [Function96 V2](https://github.com/qmk/qmk_firmware/tree/0.13.0/keyboards/fu Additionally, the `crkbd/rev1/legacy` keyboard has been removed. -### Bootmagic Deprecation and Refactor ([#12172](https://github.com/qmk/qmk_firmware/pull/12172)) +### Bootmagic Deprecation and Refactor ([#12172](https://github.com/qmk/qmk_firmware/pull/12172)) :id=bootmagic-deprecation-and-refactor QMK has decided to deprecate the full Bootmagic feature and leave Bootmagic Lite as the only remaining option. @@ -37,10 +39,9 @@ This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`: - From 2021 Nov 27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail. -## Detailed Change List - +## Core Changes :id=core-changes -### Changes Requiring User Action +### Updated Keyboard Codebases :id=updated-keyboard-codebases * Durgod keyboard refactor in preparation for adding additional durgod keyboards ([#11978](https://github.com/qmk/qmk_firmware/pull/11978)) * Change `BOOTMAGIC_ENABLE=yes` to use Bootmagic Lite ([#12172](https://github.com/qmk/qmk_firmware/pull/12172)) @@ -48,7 +49,7 @@ This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`: * [Keyboard] updated a vendor name / fixed minor keymap issues ([#12881](https://github.com/qmk/qmk_firmware/pull/12881)) * [Keyboard] Corne - Remove legacy revision support ([#12226](https://github.com/qmk/qmk_firmware/pull/12226)) -### Fixes +### Fixes :id=core-fixes * Fix connection issue in split keyboards when slave and OLED display are connected via I2C (fixes #9335) ([#11487](https://github.com/qmk/qmk_firmware/pull/11487)) * Terrazzo: Fix wrong LED Matrix function names ([#12561](https://github.com/qmk/qmk_firmware/pull/12561)) @@ -67,7 +68,7 @@ This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`: * Do not hard set config in CPTC files ([#11864](https://github.com/qmk/qmk_firmware/pull/11864)) * Fix keyboards/keymaps for boolean encoder callback changes ([#12985](https://github.com/qmk/qmk_firmware/pull/12985)) -### Additions and Enhancements +### Additions and Enhancements :id=core-additions * ARM - Refactor SLEEP_LED to support more platforms ([#8403](https://github.com/qmk/qmk_firmware/pull/8403)) * Add ability to toggle One Shot functionality ([#4198](https://github.com/qmk/qmk_firmware/pull/4198)) @@ -112,7 +113,7 @@ This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`: * Backlight: add defines for default level and breathing state ([#12560](https://github.com/qmk/qmk_firmware/pull/12560)) * Add dire message about LUFA mass storage bootloader ([#13014](https://github.com/qmk/qmk_firmware/pull/13014)) -### Clean-ups and Optimizations +### Clean-ups and Optimizations :id=core-optimizations * Overhaul bootmagic logic to have single entrypoint ([#8532](https://github.com/qmk/qmk_firmware/pull/8532)) * Refactor of USB code within split_common ([#11890](https://github.com/qmk/qmk_firmware/pull/11890)) @@ -137,7 +138,7 @@ This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`: * Deprecate `send_unicode_hex_string()` ([#12602](https://github.com/qmk/qmk_firmware/pull/12602)) * [Keyboard] Remove redundant legacy and common headers for crkbd ([#13023](https://github.com/qmk/qmk_firmware/pull/13023)) -### QMK Infrastructure and Internals +### QMK Infrastructure and Internals :id=qmk-internals * trivial change to trigger api update ([`b15288fb87`](https://github.com/qmk/qmk_firmware/commit/b15288fb87)) * fix some references to bin/qmk that slipped in ([#12832](https://github.com/qmk/qmk_firmware/pull/12832)) From 81fc1ca06ef26e23cca6ac53972ba166bb52d536 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sat, 29 May 2021 10:25:41 -0700 Subject: [PATCH 09/16] re-sort changelog --- docs/ChangeLog/20210529.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/ChangeLog/20210529.md b/docs/ChangeLog/20210529.md index 1582df84f377..b703005d7c58 100644 --- a/docs/ChangeLog/20210529.md +++ b/docs/ChangeLog/20210529.md @@ -3,7 +3,12 @@ ## Changes Requiring User Action :id=changes-requiring-user-action -### Relocated Keyboards :id=relocated-keyboards +### Updated Keyboard Codebases :id=updated-keyboard-codebases + +* Durgod keyboard refactor in preparation for adding additional durgod keyboards ([#11978](https://github.com/qmk/qmk_firmware/pull/11978)) +* Updated Function96 with V2 files and removed chconf.h and halconf.h ([#12613](https://github.com/qmk/qmk_firmware/pull/12613)) +* [Keyboard] updated a vendor name / fixed minor keymap issues ([#12881](https://github.com/qmk/qmk_firmware/pull/12881)) +* [Keyboard] Corne - Remove legacy revision support ([#12226](https://github.com/qmk/qmk_firmware/pull/12226)) The following keyboards have had their source moved within QMK: @@ -22,6 +27,8 @@ nckiibs/waaffle/rev3/pro_micro | delikeeb/waaffle/rev3/pro_micro The [Function96 V2](https://github.com/qmk/qmk_firmware/tree/0.13.0/keyboards/function96/v2) has also been added as part of these changes. +The codebase for the [Durgod K320](https://github.com/qmk/qmk_firmware/tree/0.13.0/keyboards/durgod/k320) has been reworked in anticipation of additional Durgod keyboards gaining QMK support. + Additionally, the `crkbd/rev1/legacy` keyboard has been removed. ### Bootmagic Deprecation and Refactor ([#12172](https://github.com/qmk/qmk_firmware/pull/12172)) :id=bootmagic-deprecation-and-refactor @@ -41,14 +48,6 @@ This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`: ## Core Changes :id=core-changes -### Updated Keyboard Codebases :id=updated-keyboard-codebases - -* Durgod keyboard refactor in preparation for adding additional durgod keyboards ([#11978](https://github.com/qmk/qmk_firmware/pull/11978)) -* Change `BOOTMAGIC_ENABLE=yes` to use Bootmagic Lite ([#12172](https://github.com/qmk/qmk_firmware/pull/12172)) -* Updated Function96 with V2 files and removed chconf.h and halconf.h ([#12613](https://github.com/qmk/qmk_firmware/pull/12613)) -* [Keyboard] updated a vendor name / fixed minor keymap issues ([#12881](https://github.com/qmk/qmk_firmware/pull/12881)) -* [Keyboard] Corne - Remove legacy revision support ([#12226](https://github.com/qmk/qmk_firmware/pull/12226)) - ### Fixes :id=core-fixes * Fix connection issue in split keyboards when slave and OLED display are connected via I2C (fixes #9335) ([#11487](https://github.com/qmk/qmk_firmware/pull/11487)) @@ -86,6 +85,7 @@ This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`: * add kinesis/kint36 keyboard ([#10171](https://github.com/qmk/qmk_firmware/pull/10171)) * Add support for producing UF2-format binaries. ([#12435](https://github.com/qmk/qmk_firmware/pull/12435)) * Implement CIE1931 curve for LED Matrix ([#12417](https://github.com/qmk/qmk_firmware/pull/12417)) +* Change `BOOTMAGIC_ENABLE=yes` to use Bootmagic Lite ([#12172](https://github.com/qmk/qmk_firmware/pull/12172)) * Add kzar keymap for Kinesis Advantage ([#12444](https://github.com/qmk/qmk_firmware/pull/12444)) * LED Matrix: suspend code ([#12509](https://github.com/qmk/qmk_firmware/pull/12509)) * LED Matrix: Task system ([#12580](https://github.com/qmk/qmk_firmware/pull/12580)) @@ -149,6 +149,4 @@ This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`: ---- -* Branch point for 2021 May 29 Breaking Change ([`c7a7982e23`](https://github.com/qmk/qmk_firmware/commit/c7a7982e23)) - PR List last updated: 2021-05-27 23:11:20 -07:00 From 39ebbac67fc394452f9d95cbca2a0cfbfa0ba076 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sat, 29 May 2021 10:27:58 -0700 Subject: [PATCH 10/16] add additional note regarding Bootmagic changes --- docs/ChangeLog/20210529.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/ChangeLog/20210529.md b/docs/ChangeLog/20210529.md index b703005d7c58..c13d8e051f39 100644 --- a/docs/ChangeLog/20210529.md +++ b/docs/ChangeLog/20210529.md @@ -37,6 +37,8 @@ QMK has decided to deprecate the full Bootmagic feature and leave Bootmagic Lite This pull request changes the behavior of `BOOTMAGIC_ENABLE` such that specifying `BOOTMAGIC_ENABLE = yes` enables Bootmagic Lite instead of full Bootmagic. +If attempts to use Bootmagic functionality result in unexpected behavior, check your `rules.mk` file and change the `BOOTMAGIC_ENABLE` setting to specify either `lite` or `full`. + #### Tentative Deprecation Schedule This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`: From d8b2c24863339def685c48270fc496f777d5de84 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sat, 29 May 2021 10:31:17 -0700 Subject: [PATCH 11/16] remove changelog timestamp --- docs/ChangeLog/20210529.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/ChangeLog/20210529.md b/docs/ChangeLog/20210529.md index c13d8e051f39..c554aad71c06 100644 --- a/docs/ChangeLog/20210529.md +++ b/docs/ChangeLog/20210529.md @@ -147,8 +147,3 @@ This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`: * Resolve a number of warnings in `qmk generate-api` ([#12833](https://github.com/qmk/qmk_firmware/pull/12833)) * Fix another bin/qmk reference ([#12856](https://github.com/qmk/qmk_firmware/pull/12856)) * Use milc.subcommand.config instead of qmk.cli.config ([#12915](https://github.com/qmk/qmk_firmware/pull/12915)) - - ----- - -PR List last updated: 2021-05-27 23:11:20 -07:00 From a3b3f8273fd4b1265b6bb2abb49edc8b25bed42b Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sat, 29 May 2021 10:36:48 -0700 Subject: [PATCH 12/16] update dates in main Breaking Changes docs --- docs/_summary.md | 2 +- docs/breaking_changes.md | 15 ++++++++------- docs/breaking_changes_history.md | 1 + 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/_summary.md b/docs/_summary.md index 825514e6b5d3..38937771f64e 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -120,7 +120,7 @@ * Breaking Changes * [Overview](breaking_changes.md) * [My Pull Request Was Flagged](breaking_changes_instructions.md) - * [Most Recent ChangeLog](ChangeLog/20210227.md "QMK v0.12.0 - 2021 Feb 27") + * [Most Recent ChangeLog](ChangeLog/20210529.md "QMK v0.13.0 - 2021 May 29") * [Past Breaking Changes](breaking_changes_history.md) * C Development diff --git a/docs/breaking_changes.md b/docs/breaking_changes.md index 0503789cdbde..3e85a70761d2 100644 --- a/docs/breaking_changes.md +++ b/docs/breaking_changes.md @@ -6,6 +6,7 @@ The breaking change period is when we will merge PR's that change QMK in dangero ## What has been included in past Breaking Changes? +* [2021 May 29](ChangeLog/20210529.md) * [2021 Feb 27](ChangeLog/20210227.md) * [2020 Nov 28](ChangeLog/20201128.md) * [2020 Aug 29](ChangeLog/20200829.md) @@ -15,16 +16,16 @@ The breaking change period is when we will merge PR's that change QMK in dangero ## When is the next Breaking Change? -The next Breaking Change is scheduled for May 29, 2021. +The next Breaking Change is scheduled for August 28, 2021. ### Important Dates -* [x] 2021 Feb 27 - `develop` is created. Each push to `master` is subsequently merged to `develop` -* [ ] 2021 May 01 - `develop` closed to new PR's. -* [ ] 2021 May 01 - Call for testers. -* [ ] 2021 May 27 - `master` is locked, no PR's merged. -* [ ] 2021 May 29 - Merge `develop` to `master`. -* [ ] 2021 May 29 - `master` is unlocked. PR's can be merged again. +* [x] 2021 May 29 - `develop` is created. Each push to `master` is subsequently merged to `develop` +* [ ] 2021 Jul 31 - `develop` closed to new PR's. +* [ ] 2021 Jul 31 - Call for testers. +* [ ] 2021 Aug 26 - `master` is locked, no PR's merged. +* [ ] 2021 Aug 28 - Merge `develop` to `master`. +* [ ] 2021 Aug 28 - `master` is unlocked. PR's can be merged again. ## What changes will be included? diff --git a/docs/breaking_changes_history.md b/docs/breaking_changes_history.md index dd474f1bb7ca..6ba8fe3b0674 100644 --- a/docs/breaking_changes_history.md +++ b/docs/breaking_changes_history.md @@ -2,6 +2,7 @@ This page links to all previous changelogs from the QMK Breaking Changes process. +* [2021 May 29](ChangeLog/20210529.md) - version 0.13.0 * [2021 Feb 27](ChangeLog/20210227.md) - version 0.12.0 * [2020 Nov 28](ChangeLog/20201128.md) - version 0.11.0 * [2020 Aug 29](ChangeLog/20200829.md) - version 0.10.0 From 429858afc3918e74447e37992326897d4ca3ba44 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sat, 29 May 2021 10:41:33 -0700 Subject: [PATCH 13/16] fix broken section anchors in previous changelogs --- docs/ChangeLog/20200829.md | 2 +- docs/ChangeLog/20201128.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/ChangeLog/20200829.md b/docs/ChangeLog/20200829.md index 00e0bd1a2872..c6abed5b3023 100644 --- a/docs/ChangeLog/20200829.md +++ b/docs/ChangeLog/20200829.md @@ -5,7 +5,7 @@ Four times a year QMK runs a process for merging Breaking Changes. A Breaking Ch ## Changes Requiring User Action :id=changes-requiring-user-action -### Relocated Keyboards :id-relocated-keyboards +### Relocated Keyboards :id=relocated-keyboards #### The Key Company project consolidation ([#9547](https://github.com/qmk/qmk_firmware/pull/9547)) #### relocating boards by flehrad to flehrad/ folder ([#9635](https://github.com/qmk/qmk_firmware/pull/9635)) diff --git a/docs/ChangeLog/20201128.md b/docs/ChangeLog/20201128.md index 86abd384df74..444132029532 100644 --- a/docs/ChangeLog/20201128.md +++ b/docs/ChangeLog/20201128.md @@ -5,7 +5,7 @@ Four times a year QMK runs a process for merging Breaking Changes. A Breaking Ch ## Changes Requiring User Action :id=changes-requiring-user-action -### Relocated Keyboards :id-relocated-keyboards +### Relocated Keyboards :id=relocated-keyboards #### Reduce Helix keyboard build variation ([#8669](https://github.com/qmk/qmk_firmware/pull/8669)) From 2c0fc5e6f9176ece2b0aa697e2f7de401ea898cc Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sat, 29 May 2021 11:45:47 -0700 Subject: [PATCH 14/16] add link to backlight/eeprom patch to changelog --- docs/ChangeLog/20210529.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ChangeLog/20210529.md b/docs/ChangeLog/20210529.md index c554aad71c06..667a901002b0 100644 --- a/docs/ChangeLog/20210529.md +++ b/docs/ChangeLog/20210529.md @@ -112,7 +112,7 @@ This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`: * [Keymap] Update to Drashna keymap and user code (based on develop) ([#12936](https://github.com/qmk/qmk_firmware/pull/12936)) * Add Full-duplex serial driver for ARM boards ([#9842](https://github.com/qmk/qmk_firmware/pull/9842)) * Document LED_MATRIX_FRAMEBUFFER_EFFECTS ([#12987](https://github.com/qmk/qmk_firmware/pull/12987)) -* Backlight: add defines for default level and breathing state ([#12560](https://github.com/qmk/qmk_firmware/pull/12560)) +* Backlight: add defines for default level and breathing state ([#12560](https://github.com/qmk/qmk_firmware/pull/12560), [#13024](https://github.com/qmk/qmk_firmware/pull/13024)) * Add dire message about LUFA mass storage bootloader ([#13014](https://github.com/qmk/qmk_firmware/pull/13014)) ### Clean-ups and Optimizations :id=core-optimizations From 0d59188e962ba55171ef3cb9dba05ac784b88e9a Mon Sep 17 00:00:00 2001 From: Zach White Date: Sat, 29 May 2021 12:14:04 -0700 Subject: [PATCH 15/16] highlight some more changes --- docs/ChangeLog/20210529.md | 44 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/docs/ChangeLog/20210529.md b/docs/ChangeLog/20210529.md index 667a901002b0..74c4d41a27c4 100644 --- a/docs/ChangeLog/20210529.md +++ b/docs/ChangeLog/20210529.md @@ -1,5 +1,26 @@ # QMK Breaking Changes - 2021 May 29 Changelog +## Notable Changes :id=notable-changes + +### RGB Matrix support for split common :id=rgb-matrix-split-common + +Split boards can now use RGB Matrix without defining a custom matrix. ([#11055](https://github.com/qmk/qmk_firmware/pull/11055)) + +### Teensy 3.6 support + +Added support for MK66F18 (Teensy 3.6) microcontroller ([#12258](https://github.com/qmk/qmk_firmware/pull/12258)) + +### New command: qmk console :id=new-command-qmk-console + +A new `qmk console` command has been added for attaching to your keyboard's console. It operates similiarly to QMK Toolbox by allowing you to connect to one or more keyboard consoles to display debugging messages. ([#12828](https://github.com/qmk/qmk_firmware/pull/12828)) + +### Improved command: qmk config :id=improve-command-qmk-config + +We've updated the `qmk config` command to show only the configuration items you have actually set. You can now display (almost) all of the available configuration options, along with their default values, using `qmk config -a`. + +### LED Matrix Improvements + +LED Matrix has been improved with effects, CIE1931 curves, and a task system. ([#12509](https://github.com/qmk/qmk_firmware/pull/12509)) ([#12580](https://github.com/qmk/qmk_firmware/pull/12580)) ([#12588](https://github.com/qmk/qmk_firmware/pull/12588)) ([#12633](https://github.com/qmk/qmk_firmware/pull/12633)) ([#12651](https://github.com/qmk/qmk_firmware/pull/12651)) ([#12685](https://github.com/qmk/qmk_firmware/pull/12685)) ## Changes Requiring User Action :id=changes-requiring-user-action @@ -47,6 +68,29 @@ This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`: - From 2021 Aug 28, `BOOTMAGIC_ENABLE` must be either `yes`, `lite`, or `no` – setting `BOOTMAGIC_ENABLE = full` will cause compilation to fail. - From 2021 Nov 27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail. +### Removal of LAYOUT_kc :id=removal-of-layout-kc + +We've removed support for `LAYOUT_kc` macros, if your keymap uses one you will need to update it use a regular `LAYOUT` macro. ([#12160](https://github.com/qmk/qmk_firmware/pull/12160)) + +### Encoder callbacks are now boolean :id=encoder-callback-boolean + +To allow for keyboards to override (or not) keymap level code the `encoder_update_kb` function has been changed from `void` to `bool`. You will need to update your function definition to reflect this and ensure that you return a `true` or `false` value. + +Example code before change: + +```c +void encoder_update_kb(uint8_t index, bool clockwise) { + encoder_update_user(index, clockwise); +} +``` + +Example code after change: + +```c +bool encoder_update_kb(uint8_t index, bool clockwise) { + return encoder_update_user(index, clockwise); +} +``` ## Core Changes :id=core-changes From 2d6d74567772a52732ec36c1683175557dc366f4 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sat, 29 May 2021 12:26:41 -0700 Subject: [PATCH 16/16] link PRs from section headers --- docs/ChangeLog/20210529.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/ChangeLog/20210529.md b/docs/ChangeLog/20210529.md index 74c4d41a27c4..d005aeed3668 100644 --- a/docs/ChangeLog/20210529.md +++ b/docs/ChangeLog/20210529.md @@ -2,25 +2,25 @@ ## Notable Changes :id=notable-changes -### RGB Matrix support for split common :id=rgb-matrix-split-common +### RGB Matrix support for split common ([#11055](https://github.com/qmk/qmk_firmware/pull/11055)) :id=rgb-matrix-split-common -Split boards can now use RGB Matrix without defining a custom matrix. ([#11055](https://github.com/qmk/qmk_firmware/pull/11055)) +Split boards can now use RGB Matrix without defining a custom matrix. -### Teensy 3.6 support +### Teensy 3.6 support ([#12258](https://github.com/qmk/qmk_firmware/pull/12258)) :id=teensy-3-6-support -Added support for MK66F18 (Teensy 3.6) microcontroller ([#12258](https://github.com/qmk/qmk_firmware/pull/12258)) +Added support for MK66F18 (Teensy 3.6) microcontroller. -### New command: qmk console :id=new-command-qmk-console +### New command: qmk console ([#12828](https://github.com/qmk/qmk_firmware/pull/12828)) :id=new-command-qmk-console -A new `qmk console` command has been added for attaching to your keyboard's console. It operates similiarly to QMK Toolbox by allowing you to connect to one or more keyboard consoles to display debugging messages. ([#12828](https://github.com/qmk/qmk_firmware/pull/12828)) +A new `qmk console` command has been added for attaching to your keyboard's console. It operates similiarly to QMK Toolbox by allowing you to connect to one or more keyboard consoles to display debugging messages. ### Improved command: qmk config :id=improve-command-qmk-config We've updated the `qmk config` command to show only the configuration items you have actually set. You can now display (almost) all of the available configuration options, along with their default values, using `qmk config -a`. -### LED Matrix Improvements +### LED Matrix Improvements ([#12509](https://github.com/qmk/qmk_firmware/pull/12509), [#12580](https://github.com/qmk/qmk_firmware/pull/12580), [#12588](https://github.com/qmk/qmk_firmware/pull/12588), [#12633](https://github.com/qmk/qmk_firmware/pull/12633), [#12651](https://github.com/qmk/qmk_firmware/pull/12651), [#12685](https://github.com/qmk/qmk_firmware/pull/12685)) :id=led-matrix-improvements -LED Matrix has been improved with effects, CIE1931 curves, and a task system. ([#12509](https://github.com/qmk/qmk_firmware/pull/12509)) ([#12580](https://github.com/qmk/qmk_firmware/pull/12580)) ([#12588](https://github.com/qmk/qmk_firmware/pull/12588)) ([#12633](https://github.com/qmk/qmk_firmware/pull/12633)) ([#12651](https://github.com/qmk/qmk_firmware/pull/12651)) ([#12685](https://github.com/qmk/qmk_firmware/pull/12685)) +LED Matrix has been improved with effects, CIE1931 curves, and a task system. ## Changes Requiring User Action :id=changes-requiring-user-action @@ -68,11 +68,11 @@ This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`: - From 2021 Aug 28, `BOOTMAGIC_ENABLE` must be either `yes`, `lite`, or `no` – setting `BOOTMAGIC_ENABLE = full` will cause compilation to fail. - From 2021 Nov 27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail. -### Removal of LAYOUT_kc :id=removal-of-layout-kc +### Removal of LAYOUT_kc ([#12160](https://github.com/qmk/qmk_firmware/pull/12160)) :id=removal-of-layout-kc -We've removed support for `LAYOUT_kc` macros, if your keymap uses one you will need to update it use a regular `LAYOUT` macro. ([#12160](https://github.com/qmk/qmk_firmware/pull/12160)) +We've removed support for `LAYOUT_kc` macros, if your keymap uses one you will need to update it use a regular `LAYOUT` macro. -### Encoder callbacks are now boolean :id=encoder-callback-boolean +### Encoder callbacks are now boolean ([#12805](https://github.com/qmk/qmk_firmware/pull/12805), [#12985](https://github.com/qmk/qmk_firmware/pull/12985)) :id=encoder-callback-boolean To allow for keyboards to override (or not) keymap level code the `encoder_update_kb` function has been changed from `void` to `bool`. You will need to update your function definition to reflect this and ensure that you return a `true` or `false` value. @@ -111,7 +111,6 @@ bool encoder_update_kb(uint8_t index, bool clockwise) { * ensure we do not conflict with existing keymap aliases ([#12976](https://github.com/qmk/qmk_firmware/pull/12976)) * [Keyboard] Fix Terrazzo build failure ([#12977](https://github.com/qmk/qmk_firmware/pull/12977)) * Do not hard set config in CPTC files ([#11864](https://github.com/qmk/qmk_firmware/pull/11864)) -* Fix keyboards/keymaps for boolean encoder callback changes ([#12985](https://github.com/qmk/qmk_firmware/pull/12985)) ### Additions and Enhancements :id=core-additions @@ -152,7 +151,7 @@ bool encoder_update_kb(uint8_t index, bool clockwise) { * LED Matrix: Documentation ([#12685](https://github.com/qmk/qmk_firmware/pull/12685)) * Add function to allow repeated blinking of one layer ([#12237](https://github.com/qmk/qmk_firmware/pull/12237)) * Add support for up to 4 IS31FL3733 drivers ([#12342](https://github.com/qmk/qmk_firmware/pull/12342)) -* Convert Encoder callbacks to be boolean functions ([#12805](https://github.com/qmk/qmk_firmware/pull/12805)) +* Convert Encoder callbacks to be boolean functions ([#12805](https://github.com/qmk/qmk_firmware/pull/12805), [#12985](https://github.com/qmk/qmk_firmware/pull/12985)) * [Keymap] Update to Drashna keymap and user code (based on develop) ([#12936](https://github.com/qmk/qmk_firmware/pull/12936)) * Add Full-duplex serial driver for ARM boards ([#9842](https://github.com/qmk/qmk_firmware/pull/9842)) * Document LED_MATRIX_FRAMEBUFFER_EFFECTS ([#12987](https://github.com/qmk/qmk_firmware/pull/12987))