From c0fa9e234cba70ac2b60f4d99d3b0be181954b57 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Wed, 29 Apr 2020 16:25:00 -0700 Subject: [PATCH 01/30] Post ChangeLog for Keycode Migration PRs --- docs/ChangeLog/20200530/PR8954.md | 39 +++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 docs/ChangeLog/20200530/PR8954.md diff --git a/docs/ChangeLog/20200530/PR8954.md b/docs/ChangeLog/20200530/PR8954.md new file mode 100644 index 000000000000..3a69258810ec --- /dev/null +++ b/docs/ChangeLog/20200530/PR8954.md @@ -0,0 +1,39 @@ +## Keycode Migration PRs + +Authored by fauxpark, these pull requests remove references to deprecated TMK macros that have been superseded by native QMK keycodes. + + +### Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954) + +Replaces calls to `ACTION_LAYER_TOGGLE`, which has been replaced by the `TG()` keycode. + +Calls to keycodes that call `ACTION_LAYER_TOGGLE(layer)` can be made by calling `TG(layer)` directly as a keycode. + + +### Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957) + +Replaces calls to `ACTION_MODS_ONESHOT`, which has been replaced by the `OSM()` keycode, and calls to `ACTION_LAYER_ONESHOT` with `OSL()`. + +Calls to keycodes that call `ACTION_MODS_ONESHOT(mod)` can be made by calling `OSM(mod)` directly as a keycode. +Calls to keycodes that call `ACTION_LAYER_ONESHOT(mod)` can be made by calling `OSL(mod)` directly as a keycode. + + +### Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958) + +Replaces calls to `ACTION_DEFAULT_LAYER_SET`, which has been replaced by the `DF()` keycode. + +Calls to keycodes that call `ACTION_DEFAULT_LAYER_SET(layer)` can be made by calling `DF(layer)` directly as a keycode. + + +### Migrate `ACTION_LAYER_MODS` to `LM()` (#8959) + +Replaces calls to `ACTION_LAYER_MODS`, which has been replaced by the `LM()` keycode. + +Calls to keycodes that call `ACTION_LAYER_MODS(layer, mod)` can be made by calling `LM(layer, mod)` directly as a keycode. + + +### Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968) + +Replaces calls to `ACTION_MODS_TAP_KEY`, which has been replaced by the `MT()` keycode. + +Calls to keycodes that call `ACTION_MODS_TAP_KEY(mod, kc)` can be made by calling `MT(mod, kc)` directly as a keycode. From a9bae6902521dadf9e7f0d55a214c0c0ab9673af Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Wed, 29 Apr 2020 16:48:20 -0700 Subject: [PATCH 02/30] use a table --- docs/ChangeLog/20200530/PR8954.md | 51 ++++++++++--------------------- 1 file changed, 16 insertions(+), 35 deletions(-) diff --git a/docs/ChangeLog/20200530/PR8954.md b/docs/ChangeLog/20200530/PR8954.md index 3a69258810ec..7682775c87bb 100644 --- a/docs/ChangeLog/20200530/PR8954.md +++ b/docs/ChangeLog/20200530/PR8954.md @@ -2,38 +2,19 @@ Authored by fauxpark, these pull requests remove references to deprecated TMK macros that have been superseded by native QMK keycodes. - -### Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954) - -Replaces calls to `ACTION_LAYER_TOGGLE`, which has been replaced by the `TG()` keycode. - -Calls to keycodes that call `ACTION_LAYER_TOGGLE(layer)` can be made by calling `TG(layer)` directly as a keycode. - - -### Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957) - -Replaces calls to `ACTION_MODS_ONESHOT`, which has been replaced by the `OSM()` keycode, and calls to `ACTION_LAYER_ONESHOT` with `OSL()`. - -Calls to keycodes that call `ACTION_MODS_ONESHOT(mod)` can be made by calling `OSM(mod)` directly as a keycode. -Calls to keycodes that call `ACTION_LAYER_ONESHOT(mod)` can be made by calling `OSL(mod)` directly as a keycode. - - -### Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958) - -Replaces calls to `ACTION_DEFAULT_LAYER_SET`, which has been replaced by the `DF()` keycode. - -Calls to keycodes that call `ACTION_DEFAULT_LAYER_SET(layer)` can be made by calling `DF(layer)` directly as a keycode. - - -### Migrate `ACTION_LAYER_MODS` to `LM()` (#8959) - -Replaces calls to `ACTION_LAYER_MODS`, which has been replaced by the `LM()` keycode. - -Calls to keycodes that call `ACTION_LAYER_MODS(layer, mod)` can be made by calling `LM(layer, mod)` directly as a keycode. - - -### Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968) - -Replaces calls to `ACTION_MODS_TAP_KEY`, which has been replaced by the `MT()` keycode. - -Calls to keycodes that call `ACTION_MODS_TAP_KEY(mod, kc)` can be made by calling `MT(mod, kc)` directly as a keycode. +Old `fn_actions` action | New QMK keycode +:---------------------- | :-------------- +`ACTION_DEFAULT_LAYER_SET(layer)` | `DF(layer)` +`ACTION_LAYER_MODS(layer, mod)` | `LM(layer, mod)` +`ACTION_LAYER_ONESHOT(mod)` | `OSL(mod)` +`ACTION_LAYER_TOGGLE(layer)` | `TG(layer)` +`ACTION_MODS_ONESHOT(mod)` | `OSM(mod)` +`ACTION_MODS_TAP_KEY(mod, kc)` | `MT(mod, kc)` + +### Pull Requests + +- Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954) +- Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957) +- Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958) +- Migrate `ACTION_LAYER_MODS` to `LM()` (#8959) +- Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968) From 3c2fc46ee9f864bf4d1de8d9d5aea49f12eac197 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Wed, 29 Apr 2020 17:01:20 -0700 Subject: [PATCH 03/30] link the PRs --- docs/ChangeLog/20200530/PR8954.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/ChangeLog/20200530/PR8954.md b/docs/ChangeLog/20200530/PR8954.md index 7682775c87bb..788ea94165e6 100644 --- a/docs/ChangeLog/20200530/PR8954.md +++ b/docs/ChangeLog/20200530/PR8954.md @@ -13,8 +13,8 @@ Old `fn_actions` action | New QMK keycode ### Pull Requests -- Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954) -- Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957) -- Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958) -- Migrate `ACTION_LAYER_MODS` to `LM()` (#8959) -- Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968) +- [Migrate \`ACTION_LAYER_TOGGLE\` to \`TG()\`](https://github.com/qmk/qmk_firmware/pull/8954) (#8954) +- [Migrate \`ACTION_MODS_ONESHOT\` to \`OSM()\`](https://github.com/qmk/qmk_firmware/pull/8957) (#8957) +- [Migrate \`ACTION_DEFAULT_LAYER_SET\` to \`DF()\`](https://github.com/qmk/qmk_firmware/pull/8958) (#8958) +- [Migrate \`ACTION_LAYER_MODS\` to \`LM()\`](https://github.com/qmk/qmk_firmware/pull/8959) (#8959) +- [Migrate \`ACTION_MODS_TAP_KEY\` to \`MT()\`](https://github.com/qmk/qmk_firmware/pull/8968) (#8968) From 8b35155e8f653ebb259879aa703332aedbf919d0 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sat, 9 May 2020 22:03:13 -0700 Subject: [PATCH 04/30] Add notes for 8977 and 8979 --- docs/ChangeLog/20200530/PR8954.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/ChangeLog/20200530/PR8954.md b/docs/ChangeLog/20200530/PR8954.md index 788ea94165e6..1804e63d412b 100644 --- a/docs/ChangeLog/20200530/PR8954.md +++ b/docs/ChangeLog/20200530/PR8954.md @@ -10,6 +10,7 @@ Old `fn_actions` action | New QMK keycode `ACTION_LAYER_TOGGLE(layer)` | `TG(layer)` `ACTION_MODS_ONESHOT(mod)` | `OSM(mod)` `ACTION_MODS_TAP_KEY(mod, kc)` | `MT(mod, kc)` +`ACTION_MODS_KEY(mod, kc)`
e.g. `ACTION_MODS_KEY(MOD_LCTL, KC_0)` | `MOD(kc)`
e.g. `LCTL(KC_0)` ### Pull Requests @@ -18,3 +19,5 @@ Old `fn_actions` action | New QMK keycode - [Migrate \`ACTION_DEFAULT_LAYER_SET\` to \`DF()\`](https://github.com/qmk/qmk_firmware/pull/8958) (#8958) - [Migrate \`ACTION_LAYER_MODS\` to \`LM()\`](https://github.com/qmk/qmk_firmware/pull/8959) (#8959) - [Migrate \`ACTION_MODS_TAP_KEY\` to \`MT()\`](https://github.com/qmk/qmk_firmware/pull/8968) (#8968) +- [Migrate miscellaneous `fn_actions` entries](https://github.com/qmk/qmk_firmware/pull/8977) (#8977) +- [Migrate `ACTION_MODS_KEY` to chained mod keycodes](https://github.com/qmk/qmk_firmware/pull/8979) (#8979) From ee7a7b7ec729cded5d70b82dafa15d6767ef4c76 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sat, 9 May 2020 23:41:44 -0700 Subject: [PATCH 05/30] Add ChangeLog for PR9019 --- docs/ChangeLog/20200530/PR9019.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 docs/ChangeLog/20200530/PR9019.md diff --git a/docs/ChangeLog/20200530/PR9019.md b/docs/ChangeLog/20200530/PR9019.md new file mode 100644 index 000000000000..db4f9440071b --- /dev/null +++ b/docs/ChangeLog/20200530/PR9019.md @@ -0,0 +1,3 @@ +# Switch to qmk forks for everything + +Fork all QMK submodules to protect against upstream repositories disappearing. From 6221a9e49a9e3d3101cec0d5a80739871498c2ab Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sun, 10 May 2020 15:34:06 -0700 Subject: [PATCH 06/30] Add ChangeLog for PR6480 --- docs/ChangeLog/20200530/PR6480.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 docs/ChangeLog/20200530/PR6480.md diff --git a/docs/ChangeLog/20200530/PR6480.md b/docs/ChangeLog/20200530/PR6480.md new file mode 100644 index 000000000000..fe001b5687ef --- /dev/null +++ b/docs/ChangeLog/20200530/PR6480.md @@ -0,0 +1,12 @@ +# Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup + +[#6480](https://github.com/qmk/qmk_firmware/pull/6480) + +- Changes `RGB_DISABLE_AFTER_TIMEOUT` to be based on milliseconds instead of ticks. +- Includes a code cleanup, resulting in a savings of 100 bytes, depending on features used. +- Fixed issues with timeouts / suspending at the wrong time not turning off all LEDs in some cases. + +The `RGB_DISABLE_AFTER_TIMEOUT` definition is now deprecated, and has been superseded by `RGB_DISABLE_TIMEOUT`. To use the new definition, rename `RGB_DISABLE_AFTER_TIMEOUT` to `RGB_DISABLE_TIMEOUT` in your `config.h` file, and multiply the value set by 1200. + +Before: `#define RGB_DISABLE_AFTER_TIMEOUT 100` +After: `#define RGB_DISABLE_TIMEOUT 120000` From 5632030b2d8a6996df45e078df09bfaab84004db Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sun, 10 May 2020 15:38:53 -0700 Subject: [PATCH 07/30] Unify ChangeLog formatting Format the first line as a Level 1 heading and follow it with a link to the relevant PR (expect for PR8954.md which covers multiple PRs). --- docs/ChangeLog/20200530/PR7114.md | 4 +++- docs/ChangeLog/20200530/PR8348.md | 2 ++ docs/ChangeLog/20200530/PR8484.md | 4 +++- docs/ChangeLog/20200530/PR8903.md | 4 +++- docs/ChangeLog/20200530/PR8954.md | 4 ++-- docs/ChangeLog/20200530/PR9000.md | 2 ++ docs/ChangeLog/20200530/PR9019.md | 2 ++ 7 files changed, 17 insertions(+), 5 deletions(-) diff --git a/docs/ChangeLog/20200530/PR7114.md b/docs/ChangeLog/20200530/PR7114.md index f9b35fba33c1..359d619dc749 100644 --- a/docs/ChangeLog/20200530/PR7114.md +++ b/docs/ChangeLog/20200530/PR7114.md @@ -1,4 +1,6 @@ -# Refactor zinc to use split_common #7114 - Changelog +# Refactor zinc to use split_common + +[#7114](https://github.com/qmk/qmk_firmware/pull/7114) * Refactor to use split_common and remove split codes under the zinc/revx/ * Add - backlight RGB LED and/or underglow RGB LED option diff --git a/docs/ChangeLog/20200530/PR8348.md b/docs/ChangeLog/20200530/PR8348.md index d6a740d302d6..57f2533a97b5 100644 --- a/docs/ChangeLog/20200530/PR8348.md +++ b/docs/ChangeLog/20200530/PR8348.md @@ -1,5 +1,7 @@ # Unify Tap Hold functions and documentation +[#8348](https://github.com/qmk/qmk_firmware/pull/8348) + Updates all of the per key tap-hold functions to pass the `keyrecord_t` structure, and include documentation changes. Any remaining versions or code outside of the main repo will need to be converted: diff --git a/docs/ChangeLog/20200530/PR8484.md b/docs/ChangeLog/20200530/PR8484.md index e5404c719b84..0490e1e20720 100644 --- a/docs/ChangeLog/20200530/PR8484.md +++ b/docs/ChangeLog/20200530/PR8484.md @@ -1 +1,3 @@ -code cleanup regarding deprecated macro PLAY_NOTE_ARRAY by replacing it with PLAY_SONG +# code cleanup regarding deprecated macro PLAY_NOTE_ARRAY by replacing it with PLAY_SONG + +[#8484](https://github.com/qmk/qmk_firmware/pull/8484) diff --git a/docs/ChangeLog/20200530/PR8903.md b/docs/ChangeLog/20200530/PR8903.md index 135791e5a7d9..a2570874a66e 100644 --- a/docs/ChangeLog/20200530/PR8903.md +++ b/docs/ChangeLog/20200530/PR8903.md @@ -1,4 +1,6 @@ -## fixing wrong configuration of AUDIO feature +# fixing wrong configuration of AUDIO feature + +[#8903](https://github.com/qmk/qmk_firmware/pull/8903) `audio_avr.c` does not default to any pin; there has to be a #define XX_AUDIO in config.h at some level for Audio to actually work. Otherwise, the Audio code ends up cluttering the firmware, possibly breaking builds because the maximum allowed firmware size is exceeded. diff --git a/docs/ChangeLog/20200530/PR8954.md b/docs/ChangeLog/20200530/PR8954.md index 1804e63d412b..cd206f122b10 100644 --- a/docs/ChangeLog/20200530/PR8954.md +++ b/docs/ChangeLog/20200530/PR8954.md @@ -1,4 +1,4 @@ -## Keycode Migration PRs +# Keycode Migration PRs Authored by fauxpark, these pull requests remove references to deprecated TMK macros that have been superseded by native QMK keycodes. @@ -12,7 +12,7 @@ Old `fn_actions` action | New QMK keycode `ACTION_MODS_TAP_KEY(mod, kc)` | `MT(mod, kc)` `ACTION_MODS_KEY(mod, kc)`
e.g. `ACTION_MODS_KEY(MOD_LCTL, KC_0)` | `MOD(kc)`
e.g. `LCTL(KC_0)` -### Pull Requests +## Pull Requests - [Migrate \`ACTION_LAYER_TOGGLE\` to \`TG()\`](https://github.com/qmk/qmk_firmware/pull/8954) (#8954) - [Migrate \`ACTION_MODS_ONESHOT\` to \`OSM()\`](https://github.com/qmk/qmk_firmware/pull/8957) (#8957) diff --git a/docs/ChangeLog/20200530/PR9000.md b/docs/ChangeLog/20200530/PR9000.md index 64a199f902d8..c8ddb72ed0c8 100644 --- a/docs/ChangeLog/20200530/PR9000.md +++ b/docs/ChangeLog/20200530/PR9000.md @@ -1,5 +1,7 @@ # Python Required In The Build Process +[#9000](https://github.com/qmk/qmk_firmware/pull/9000) + This is the last release of QMK that will work without having Python 3.6 (or later) installed. If your environment is not fully setup you will get a warning instructing you to set it up. After the next breaking change you will not be able to build if `bin/qmk hello` does not work. diff --git a/docs/ChangeLog/20200530/PR9019.md b/docs/ChangeLog/20200530/PR9019.md index db4f9440071b..9bce51408ce9 100644 --- a/docs/ChangeLog/20200530/PR9019.md +++ b/docs/ChangeLog/20200530/PR9019.md @@ -1,3 +1,5 @@ # Switch to qmk forks for everything +[#9019](https://github.com/qmk/qmk_firmware/pull/9019) + Fork all QMK submodules to protect against upstream repositories disappearing. From 4d7ee4fad58db43bcc84d2979622a735787f06d0 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sun, 10 May 2020 15:43:05 -0700 Subject: [PATCH 08/30] Unify formatting of PR8954.md --- docs/ChangeLog/20200530/PR8954.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/docs/ChangeLog/20200530/PR8954.md b/docs/ChangeLog/20200530/PR8954.md index cd206f122b10..a31b9e271355 100644 --- a/docs/ChangeLog/20200530/PR8954.md +++ b/docs/ChangeLog/20200530/PR8954.md @@ -1,5 +1,7 @@ # Keycode Migration PRs +[#8954](https://github.com/qmk/qmk_firmware/pull/8954 "Migrate `ACTION_LAYER_TOGGLE` to `TG()`"), [#8957](https://github.com/qmk/qmk_firmware/pull/8957 "Migrate `ACTION_MODS_ONESHOT` to `OSM()`"), [#8958](https://github.com/qmk/qmk_firmware/pull/8958 "Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()`"), [#8959](https://github.com/qmk/qmk_firmware/pull/8959 "Migrate `ACTION_LAYER_MODS` to `LM()`"), [#8968](https://github.com/qmk/qmk_firmware/pull/8968 "Migrate `ACTION_MODS_TAP_KEY` to `MT()`"), [#8977](https://github.com/qmk/qmk_firmware/pull/8977 "Migrate miscellaneous `fn_actions` entries"), and [#8979](https://github.com/qmk/qmk_firmware/pull/8979 "Migrate `ACTION_MODS_KEY` to chained mod keycodes") + Authored by fauxpark, these pull requests remove references to deprecated TMK macros that have been superseded by native QMK keycodes. Old `fn_actions` action | New QMK keycode @@ -11,13 +13,3 @@ Old `fn_actions` action | New QMK keycode `ACTION_MODS_ONESHOT(mod)` | `OSM(mod)` `ACTION_MODS_TAP_KEY(mod, kc)` | `MT(mod, kc)` `ACTION_MODS_KEY(mod, kc)`
e.g. `ACTION_MODS_KEY(MOD_LCTL, KC_0)` | `MOD(kc)`
e.g. `LCTL(KC_0)` - -## Pull Requests - -- [Migrate \`ACTION_LAYER_TOGGLE\` to \`TG()\`](https://github.com/qmk/qmk_firmware/pull/8954) (#8954) -- [Migrate \`ACTION_MODS_ONESHOT\` to \`OSM()\`](https://github.com/qmk/qmk_firmware/pull/8957) (#8957) -- [Migrate \`ACTION_DEFAULT_LAYER_SET\` to \`DF()\`](https://github.com/qmk/qmk_firmware/pull/8958) (#8958) -- [Migrate \`ACTION_LAYER_MODS\` to \`LM()\`](https://github.com/qmk/qmk_firmware/pull/8959) (#8959) -- [Migrate \`ACTION_MODS_TAP_KEY\` to \`MT()\`](https://github.com/qmk/qmk_firmware/pull/8968) (#8968) -- [Migrate miscellaneous `fn_actions` entries](https://github.com/qmk/qmk_firmware/pull/8977) (#8977) -- [Migrate `ACTION_MODS_KEY` to chained mod keycodes](https://github.com/qmk/qmk_firmware/pull/8979) (#8979) From 5650ccfe543f4b5815687fbb3242d74d96813fac Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sun, 10 May 2020 19:22:29 -0700 Subject: [PATCH 09/30] Concatenate ChangeLogs for Core PRs --- docs/ChangeLog/20200530/01_core_changes.md | 60 ++++++++++++++++++++++ docs/ChangeLog/20200530/PR6480.md | 12 ----- docs/ChangeLog/20200530/PR8321.md | 5 -- docs/ChangeLog/20200530/PR8348.md | 11 ---- docs/ChangeLog/20200530/PR8484.md | 3 -- docs/ChangeLog/20200530/PR8903.md | 7 --- docs/ChangeLog/20200530/PR9000.md | 7 --- docs/ChangeLog/20200530/PR9019.md | 5 -- 8 files changed, 60 insertions(+), 50 deletions(-) create mode 100644 docs/ChangeLog/20200530/01_core_changes.md delete mode 100644 docs/ChangeLog/20200530/PR6480.md delete mode 100644 docs/ChangeLog/20200530/PR8321.md delete mode 100644 docs/ChangeLog/20200530/PR8348.md delete mode 100644 docs/ChangeLog/20200530/PR8484.md delete mode 100644 docs/ChangeLog/20200530/PR8903.md delete mode 100644 docs/ChangeLog/20200530/PR9000.md delete mode 100644 docs/ChangeLog/20200530/PR9019.md diff --git a/docs/ChangeLog/20200530/01_core_changes.md b/docs/ChangeLog/20200530/01_core_changes.md new file mode 100644 index 000000000000..f62cc5ccb76c --- /dev/null +++ b/docs/ChangeLog/20200530/01_core_changes.md @@ -0,0 +1,60 @@ +## Core Changes + +### Converting V-USB usbdrv to a submodule + +[#8321](https://github.com/qmk/qmk_firmware/pull/8321) and [qmk_compiler#62](https://github.com/qmk/qmk_compiler/pull/62). + +These PRs move the V-USB driver code out of the qmk_firmware repository and into a submodule pointed at https://github.com/obdev/v-usb. This will make it easier to update the codebase if needed, while applying any potential QMK-specific modifications by forking it to the QMK GitHub organization. + +### Unify Tap Hold functions and documentation + +[#8348](https://github.com/qmk/qmk_firmware/pull/8348) + +Updates all of the per key tap-hold functions to pass the `keyrecord_t` structure, and include documentation changes. + +Any remaining versions or code outside of the main repo will need to be converted: +| Old function | New Function | +|------------------------------------------------------|---------------------------------------------------------------------------| +|`uint16_t get_tapping_term(uint16_t keycode)` |`uint16_t get_tapping_term(uint16_t keycode, keyrecord_t *record)` | +|`bool get_ignore_mod_tap_interrupt(uint16_t keycode)` |`bool get_ignore_mod_tap_interrupt(uint16_t keycode, keyrecord_t *record)` | + +### Python Required In The Build Process + +[#9000](https://github.com/qmk/qmk_firmware/pull/9000) + +This is the last release of QMK that will work without having Python 3.6 (or later) installed. If your environment is not fully setup you will get a warning instructing you to set it up. + +After the next breaking change you will not be able to build if `bin/qmk hello` does not work. + +### [#8269] + +### Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup + +[#6480](https://github.com/qmk/qmk_firmware/pull/6480) + +- Changes `RGB_DISABLE_AFTER_TIMEOUT` to be based on milliseconds instead of ticks. +- Includes a code cleanup, resulting in a savings of 100 bytes, depending on features used. +- Fixed issues with timeouts / suspending at the wrong time not turning off all LEDs in some cases. + +The `RGB_DISABLE_AFTER_TIMEOUT` definition is now deprecated, and has been superseded by `RGB_DISABLE_TIMEOUT`. To use the new definition, rename `RGB_DISABLE_AFTER_TIMEOUT` to `RGB_DISABLE_TIMEOUT` in your `config.h` file, and multiply the value set by 1200. + +Before: `#define RGB_DISABLE_AFTER_TIMEOUT 100` +After: `#define RGB_DISABLE_TIMEOUT 120000` + +### Switch to qmk forks for everything + +[#9019](https://github.com/qmk/qmk_firmware/pull/9019) + +Fork all QMK submodules to protect against upstream repositories disappearing. + +### code cleanup regarding deprecated macro PLAY_NOTE_ARRAY by replacing it with PLAY_SONG + +[#8484](https://github.com/qmk/qmk_firmware/pull/8484) + +### fixing wrong configuration of AUDIO feature + +[#8903](https://github.com/qmk/qmk_firmware/pull/8903) + +`audio_avr.c` does not default to any pin; there has to be a #define XX_AUDIO in config.h at some level for Audio to actually work. Otherwise, the Audio code ends up cluttering the firmware, possibly breaking builds because the maximum allowed firmware size is exceeded. + +These changes fix this by disabling Audio on keyboards that have the feature misconfigured, and therefore non-functional. diff --git a/docs/ChangeLog/20200530/PR6480.md b/docs/ChangeLog/20200530/PR6480.md deleted file mode 100644 index fe001b5687ef..000000000000 --- a/docs/ChangeLog/20200530/PR6480.md +++ /dev/null @@ -1,12 +0,0 @@ -# Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup - -[#6480](https://github.com/qmk/qmk_firmware/pull/6480) - -- Changes `RGB_DISABLE_AFTER_TIMEOUT` to be based on milliseconds instead of ticks. -- Includes a code cleanup, resulting in a savings of 100 bytes, depending on features used. -- Fixed issues with timeouts / suspending at the wrong time not turning off all LEDs in some cases. - -The `RGB_DISABLE_AFTER_TIMEOUT` definition is now deprecated, and has been superseded by `RGB_DISABLE_TIMEOUT`. To use the new definition, rename `RGB_DISABLE_AFTER_TIMEOUT` to `RGB_DISABLE_TIMEOUT` in your `config.h` file, and multiply the value set by 1200. - -Before: `#define RGB_DISABLE_AFTER_TIMEOUT 100` -After: `#define RGB_DISABLE_TIMEOUT 120000` diff --git a/docs/ChangeLog/20200530/PR8321.md b/docs/ChangeLog/20200530/PR8321.md deleted file mode 100644 index ebaf3b83446a..000000000000 --- a/docs/ChangeLog/20200530/PR8321.md +++ /dev/null @@ -1,5 +0,0 @@ -# Converting V-USB usbdrv to a submodule - -[#8321](https://github.com/qmk/qmk_firmware/pull/8321) and [qmk_compiler#62](https://github.com/qmk/qmk_compiler/pull/62). - -These PRs move the V-USB driver code out of the qmk_firmware repository and into a submodule pointed at https://github.com/obdev/v-usb. This will make it easier to update the codebase if needed, while applying any potential QMK-specific modifications by forking it to the QMK GitHub organization. diff --git a/docs/ChangeLog/20200530/PR8348.md b/docs/ChangeLog/20200530/PR8348.md deleted file mode 100644 index 57f2533a97b5..000000000000 --- a/docs/ChangeLog/20200530/PR8348.md +++ /dev/null @@ -1,11 +0,0 @@ -# Unify Tap Hold functions and documentation - -[#8348](https://github.com/qmk/qmk_firmware/pull/8348) - -Updates all of the per key tap-hold functions to pass the `keyrecord_t` structure, and include documentation changes. - -Any remaining versions or code outside of the main repo will need to be converted: -| Old function | New Function | -|------------------------------------------------------|---------------------------------------------------------------------------| -|`uint16_t get_tapping_term(uint16_t keycode)` |`uint16_t get_tapping_term(uint16_t keycode, keyrecord_t *record)` | -|`bool get_ignore_mod_tap_interrupt(uint16_t keycode)` |`bool get_ignore_mod_tap_interrupt(uint16_t keycode, keyrecord_t *record)` | diff --git a/docs/ChangeLog/20200530/PR8484.md b/docs/ChangeLog/20200530/PR8484.md deleted file mode 100644 index 0490e1e20720..000000000000 --- a/docs/ChangeLog/20200530/PR8484.md +++ /dev/null @@ -1,3 +0,0 @@ -# code cleanup regarding deprecated macro PLAY_NOTE_ARRAY by replacing it with PLAY_SONG - -[#8484](https://github.com/qmk/qmk_firmware/pull/8484) diff --git a/docs/ChangeLog/20200530/PR8903.md b/docs/ChangeLog/20200530/PR8903.md deleted file mode 100644 index a2570874a66e..000000000000 --- a/docs/ChangeLog/20200530/PR8903.md +++ /dev/null @@ -1,7 +0,0 @@ -# fixing wrong configuration of AUDIO feature - -[#8903](https://github.com/qmk/qmk_firmware/pull/8903) - -`audio_avr.c` does not default to any pin; there has to be a #define XX_AUDIO in config.h at some level for Audio to actually work. Otherwise, the Audio code ends up cluttering the firmware, possibly breaking builds because the maximum allowed firmware size is exceeded. - -These changes fix this by disabling Audio on keyboards that have the feature misconfigured, and therefore non-functional. diff --git a/docs/ChangeLog/20200530/PR9000.md b/docs/ChangeLog/20200530/PR9000.md deleted file mode 100644 index c8ddb72ed0c8..000000000000 --- a/docs/ChangeLog/20200530/PR9000.md +++ /dev/null @@ -1,7 +0,0 @@ -# Python Required In The Build Process - -[#9000](https://github.com/qmk/qmk_firmware/pull/9000) - -This is the last release of QMK that will work without having Python 3.6 (or later) installed. If your environment is not fully setup you will get a warning instructing you to set it up. - -After the next breaking change you will not be able to build if `bin/qmk hello` does not work. diff --git a/docs/ChangeLog/20200530/PR9019.md b/docs/ChangeLog/20200530/PR9019.md deleted file mode 100644 index 9bce51408ce9..000000000000 --- a/docs/ChangeLog/20200530/PR9019.md +++ /dev/null @@ -1,5 +0,0 @@ -# Switch to qmk forks for everything - -[#9019](https://github.com/qmk/qmk_firmware/pull/9019) - -Fork all QMK submodules to protect against upstream repositories disappearing. From 83239257f457350e6d517a9e1a4f8be6169582c8 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sun, 10 May 2020 19:26:23 -0700 Subject: [PATCH 10/30] Concatenate ChangeLogs for Keyboard Refactor PRs --- .../{PR6260.md => 02_keyboard_refactors.md} | 55 ++++++++++++++++++- docs/ChangeLog/20200530/PR7114.md | 10 ---- docs/ChangeLog/20200530/PR8472.md | 42 -------------- 3 files changed, 54 insertions(+), 53 deletions(-) rename docs/ChangeLog/20200530/{PR6260.md => 02_keyboard_refactors.md} (50%) delete mode 100644 docs/ChangeLog/20200530/PR7114.md delete mode 100644 docs/ChangeLog/20200530/PR8472.md diff --git a/docs/ChangeLog/20200530/PR6260.md b/docs/ChangeLog/20200530/02_keyboard_refactors.md similarity index 50% rename from docs/ChangeLog/20200530/PR6260.md rename to docs/ChangeLog/20200530/02_keyboard_refactors.md index a2a9534ce21d..811ff0d62941 100644 --- a/docs/ChangeLog/20200530/PR6260.md +++ b/docs/ChangeLog/20200530/02_keyboard_refactors.md @@ -35,4 +35,57 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) { - Find/Replace `matrix_render_user(struct CharacterMatrix *matrix)` with `iota_gfx_task_user(void)` - Find/Replace `is_master` with `is_keyboard_master()` - For each instance of `matrix_write_ln(matrix, display_fn())`, rewrite it as `oled_write_ln(read_layer_state(), false);` -- For each instance of `matrix_write(matrix, read_logo());`, replace with `oled_write(read_logo(), false);` \ No newline at end of file +- For each instance of `matrix_write(matrix, read_logo());`, replace with `oled_write(read_logo(), false);` +# Refactor zinc to use split_common + +[#7114](https://github.com/qmk/qmk_firmware/pull/7114) + +* Refactor to use split_common and remove split codes under the zinc/revx/ +* Add - backlight RGB LED and/or underglow RGB LED option +* Add - continuous RGB animations feature (between L and R halves) +* Fix - keymap files to adapt to changes + * all authors of keymaps confirmed this PR +* Update - documents and rules.mk + +# Refactor of TKC1800 to use common OLED code + +[#8472](https://github.com/qmk/qmk_firmware/pull/8472) Modifies the default firmware for TKC1800 to use the in-built I2C and OLED drivers, instead of including and depending on its own set of libraries for the following functionality: +- SSD1306 display +- i2c for OLED + +This allows current TKC1800 firmware to advance with updates to those drivers, which are shared with other keyboards. + +## To migrate existing TKC1800 firmware: + +[Changes to `config.h`](https://github.com/qmk/qmk_firmware/pull/8472/files#diff-d10b26e676b4a55cbb00d71955116526): +- Remove `#define SSD1306OLED` from config.h + +[Changes to `tkc1800.c`](https://github.com/qmk/qmk_firmware/pull/8472/files#diff-3b35bd30abe89c8110717c6972cd2cc5): +- Add the following to avoid debug errors on HID_listen if the screen is not present +```c +void keyboard_pre_init_kb(void) { + setPinInputHigh(D0); + setPinInputHigh(D1); + + keyboard_pre_init_user(); +} +``` + +[Changes to `keymap.c`](https://github.com/qmk/qmk_firmware/pull/8472/files#diff-05a2a344ce27e4d045fe68520ccd4771): +- Find/Replace each instance of `#ifdef SSD1306OLED` with `#ifdef OLED_DRIVER_ENABLE` +- The following changes are for compatibility with the OLED driver. If you don't use the OLED driver you may safely delete [this section](https://github.com/qmk/qmk_firmware/blob/e6b9980bd45c186f7360df68c24b6e05a80c10dc/keyboards/lily58/keymaps/default/keymap.c#L144-L190) +- [Remove](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7L91-L158) the block +```c +#ifdef SSD1306OLED + iota_gfx_init(!has_usb()); // turns on the display +#endif +``` +- Within the block bounded by `#ifdef OLED_DRIVER_ENABLE` and `#endif // OLED_DRIVER_ENABLE`, add the following block to ensure that your two OLEDs are rotated correctly across the left and right sides: +```c +oled_rotation_t oled_init_user(oled_rotation_t rotation) { + if (!is_keyboard_master()) + return OLED_ROTATION_180; // flips the display 180 degrees if offhand + return rotation; +} +``` +- Remove the function `iota_gfx_task_user` \ No newline at end of file diff --git a/docs/ChangeLog/20200530/PR7114.md b/docs/ChangeLog/20200530/PR7114.md deleted file mode 100644 index 359d619dc749..000000000000 --- a/docs/ChangeLog/20200530/PR7114.md +++ /dev/null @@ -1,10 +0,0 @@ -# Refactor zinc to use split_common - -[#7114](https://github.com/qmk/qmk_firmware/pull/7114) - -* Refactor to use split_common and remove split codes under the zinc/revx/ -* Add - backlight RGB LED and/or underglow RGB LED option -* Add - continuous RGB animations feature (between L and R halves) -* Fix - keymap files to adapt to changes - * all authors of keymaps confirmed this PR -* Update - documents and rules.mk diff --git a/docs/ChangeLog/20200530/PR8472.md b/docs/ChangeLog/20200530/PR8472.md deleted file mode 100644 index 0ed6fb8a4ad4..000000000000 --- a/docs/ChangeLog/20200530/PR8472.md +++ /dev/null @@ -1,42 +0,0 @@ -# Refactor of TKC1800 to use common OLED code - -[#8472](https://github.com/qmk/qmk_firmware/pull/8472) Modifies the default firmware for TKC1800 to use the in-built I2C and OLED drivers, instead of including and depending on its own set of libraries for the following functionality: -- SSD1306 display -- i2c for OLED - -This allows current TKC1800 firmware to advance with updates to those drivers, which are shared with other keyboards. - -## To migrate existing TKC1800 firmware: - -[Changes to `config.h`](https://github.com/qmk/qmk_firmware/pull/8472/files#diff-d10b26e676b4a55cbb00d71955116526): -- Remove `#define SSD1306OLED` from config.h - -[Changes to `tkc1800.c`](https://github.com/qmk/qmk_firmware/pull/8472/files#diff-3b35bd30abe89c8110717c6972cd2cc5): -- Add the following to avoid debug errors on HID_listen if the screen is not present -```c -void keyboard_pre_init_kb(void) { - setPinInputHigh(D0); - setPinInputHigh(D1); - - keyboard_pre_init_user(); -} -``` - -[Changes to `keymap.c`](https://github.com/qmk/qmk_firmware/pull/8472/files#diff-05a2a344ce27e4d045fe68520ccd4771): -- Find/Replace each instance of `#ifdef SSD1306OLED` with `#ifdef OLED_DRIVER_ENABLE` -- The following changes are for compatibility with the OLED driver. If you don't use the OLED driver you may safely delete [this section](https://github.com/qmk/qmk_firmware/blob/e6b9980bd45c186f7360df68c24b6e05a80c10dc/keyboards/lily58/keymaps/default/keymap.c#L144-L190) -- [Remove](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7L91-L158) the block -```c -#ifdef SSD1306OLED - iota_gfx_init(!has_usb()); // turns on the display -#endif -``` -- Within the block bounded by `#ifdef OLED_DRIVER_ENABLE` and `#endif // OLED_DRIVER_ENABLE`, add the following block to ensure that your two OLEDs are rotated correctly across the left and right sides: -```c -oled_rotation_t oled_init_user(oled_rotation_t rotation) { - if (!is_keyboard_master()) - return OLED_ROTATION_180; // flips the display 180 degrees if offhand - return rotation; -} -``` -- Remove the function `iota_gfx_task_user` \ No newline at end of file From 2c894fdc1cb996542f4d8b133b4b877a1f1d91f4 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sun, 10 May 2020 19:35:39 -0700 Subject: [PATCH 11/30] Concatenate ChangeLogs for Keyboard Move PRs --- docs/ChangeLog/20200530/03_keyboard_moves.md | 22 ++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/ChangeLog/20200530/03_keyboard_moves.md diff --git a/docs/ChangeLog/20200530/03_keyboard_moves.md b/docs/ChangeLog/20200530/03_keyboard_moves.md new file mode 100644 index 000000000000..969b4ace112f --- /dev/null +++ b/docs/ChangeLog/20200530/03_keyboard_moves.md @@ -0,0 +1,22 @@ +## Keyboard Moves + +- [#8412](https://github.com/qmk/qmk_firmware/pull/8412 "Changing board names to prevent confusion") by blindassassin111 +- [#8499](https://github.com/qmk/qmk_firmware/pull/8499 "Move the Keyboardio Model01 to a keyboardio/ subdir") by algernon +- [#8830](https://github.com/qmk/qmk_firmware/pull/8830 "Move spaceman keyboards") by Spaceman (formerly known as Rionlion100) +- [#8537](https://github.com/qmk/qmk_firmware/pull/8537 "Organizing my keyboards (plaid, tartan, ergoinu)") by hsgw + +Keyboards by Keyboardio, Spaceman (formerly Rionlion100), and hsgw move to vendor folders, while PCBs designed by blindassassin111 are renamed. + +Old Name | New Name +:----------------- | :----------------- +2_milk | spaceman/2_milk +at101_blackheart | at101_bh +ergoinu | dm9records/ergoinu +model01 | keyboardio/model01 +omnikey_blackheart | omnikey_bh +pancake | spaceman/pancake +plaid | dm9records/plaid +tartan | dm9records/tartan +z150_blackheart | z150_bh + +If you own one of these PCBs, please use the new names to compile your firmware moving forward. From d7021ac35d0e990d1e16ca427839ce6088351d95 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Sun, 10 May 2020 19:36:25 -0700 Subject: [PATCH 12/30] Rename PR8954 ChangeLog for Keycode Migration doc --- docs/ChangeLog/20200530/{PR8954.md => 04_keycode_migrations.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/ChangeLog/20200530/{PR8954.md => 04_keycode_migrations.md} (100%) diff --git a/docs/ChangeLog/20200530/PR8954.md b/docs/ChangeLog/20200530/04_keycode_migrations.md similarity index 100% rename from docs/ChangeLog/20200530/PR8954.md rename to docs/ChangeLog/20200530/04_keycode_migrations.md From 1da31923a8db11fecb105383ebc061884334abdf Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Mon, 11 May 2020 21:34:39 -0700 Subject: [PATCH 13/30] Add ChangeLog for PR8582 --- .../20200530/02_keyboard_refactors.md | 21 ++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/ChangeLog/20200530/02_keyboard_refactors.md b/docs/ChangeLog/20200530/02_keyboard_refactors.md index 811ff0d62941..1cf76517af5f 100644 --- a/docs/ChangeLog/20200530/02_keyboard_refactors.md +++ b/docs/ChangeLog/20200530/02_keyboard_refactors.md @@ -88,4 +88,23 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) { return rotation; } ``` -- Remove the function `iota_gfx_task_user` \ No newline at end of file +- Remove the function `iota_gfx_task_user` + +# Split HHKB to ANSI and JP layouts and Add VIA support for each + +[#8582](https://github.com/qmk/qmk_firmware/pull/8582) + +- Splits the HHKB codebase into two separate folders `keyboards/hhkb/ansi` and `keyboards/hhkb/jp`. +- Adds VIA Configurator support for both versions. + +## Migrating existing HHKB keymaps + +- Remove any checks for the `HHKB_JP` definition + - All checks for this definition have been removed, and each version uses the source that is appropriate to that version. +- Move the directory for your keymap into the appropriate `keymaps` directory + - `keyboards/hhkb/ansi/keymaps/` for ANSI HHKBs + - `keyboards/hhkb/jp/keymaps/` for HHKB JPs +- Compile with the new keyboard names + - This PR changes the compilation instructions for the HHKB Alternate Controller. To compile firmware for this controller moving forward, use: + - `make hhkb/ansi` for ANSI-layout HHKBs + - `make hhkb/jp` for HHKB JP keyboards From bf03a5e7d8a776b72a8ecbbe3ee771a397b43def Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Mon, 11 May 2020 21:39:17 -0700 Subject: [PATCH 14/30] Formatting for Keyboard Refactor ChangeLog section --- .../ChangeLog/20200530/02_keyboard_refactors.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/ChangeLog/20200530/02_keyboard_refactors.md b/docs/ChangeLog/20200530/02_keyboard_refactors.md index 1cf76517af5f..93b3217e372e 100644 --- a/docs/ChangeLog/20200530/02_keyboard_refactors.md +++ b/docs/ChangeLog/20200530/02_keyboard_refactors.md @@ -1,4 +1,6 @@ -# Migrating Lily58 to use split_common +## Keyboard Refactors + +### Migrating Lily58 to use split_common [#6260](https://github.com/qmk/qmk_firmware/pull/6260) Modifies the default firmware for Lily58 to use the `split_common` library, instead of including and depending on its own set of libraries for the following functionality: - SSD1306 display @@ -7,7 +9,7 @@ This allows current lily58 firmware to advance with updates to the `split_common` library, which is shared with many other split keyboards. -## To migrate existing Lily58 firmware: +#### To migrate existing Lily58 firmware: [Changes to `config.h`](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-445ac369c8717dcd6fc6fc3630836fc1): - Remove `#define SSD1306OLED` from config.h @@ -36,7 +38,8 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) { - Find/Replace `is_master` with `is_keyboard_master()` - For each instance of `matrix_write_ln(matrix, display_fn())`, rewrite it as `oled_write_ln(read_layer_state(), false);` - For each instance of `matrix_write(matrix, read_logo());`, replace with `oled_write(read_logo(), false);` -# Refactor zinc to use split_common + +### Refactor zinc to use split_common [#7114](https://github.com/qmk/qmk_firmware/pull/7114) @@ -47,7 +50,7 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) { * all authors of keymaps confirmed this PR * Update - documents and rules.mk -# Refactor of TKC1800 to use common OLED code +### Refactor of TKC1800 to use common OLED code [#8472](https://github.com/qmk/qmk_firmware/pull/8472) Modifies the default firmware for TKC1800 to use the in-built I2C and OLED drivers, instead of including and depending on its own set of libraries for the following functionality: - SSD1306 display @@ -55,7 +58,7 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) { This allows current TKC1800 firmware to advance with updates to those drivers, which are shared with other keyboards. -## To migrate existing TKC1800 firmware: +#### To migrate existing TKC1800 firmware: [Changes to `config.h`](https://github.com/qmk/qmk_firmware/pull/8472/files#diff-d10b26e676b4a55cbb00d71955116526): - Remove `#define SSD1306OLED` from config.h @@ -90,14 +93,14 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) { ``` - Remove the function `iota_gfx_task_user` -# Split HHKB to ANSI and JP layouts and Add VIA support for each +### Split HHKB to ANSI and JP layouts and Add VIA support for each [#8582](https://github.com/qmk/qmk_firmware/pull/8582) - Splits the HHKB codebase into two separate folders `keyboards/hhkb/ansi` and `keyboards/hhkb/jp`. - Adds VIA Configurator support for both versions. -## Migrating existing HHKB keymaps +#### Migrating existing HHKB keymaps - Remove any checks for the `HHKB_JP` definition - All checks for this definition have been removed, and each version uses the source that is appropriate to that version. From 186f1dfb37cbe8c5e1f447e7a6089a66c969ad53 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Mon, 11 May 2020 21:40:16 -0700 Subject: [PATCH 15/30] Formatting for Keycode Migration ChangeLog section --- docs/ChangeLog/20200530/04_keycode_migrations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ChangeLog/20200530/04_keycode_migrations.md b/docs/ChangeLog/20200530/04_keycode_migrations.md index a31b9e271355..02ea61f7bbb9 100644 --- a/docs/ChangeLog/20200530/04_keycode_migrations.md +++ b/docs/ChangeLog/20200530/04_keycode_migrations.md @@ -1,4 +1,4 @@ -# Keycode Migration PRs +## Keycode Migration PRs [#8954](https://github.com/qmk/qmk_firmware/pull/8954 "Migrate `ACTION_LAYER_TOGGLE` to `TG()`"), [#8957](https://github.com/qmk/qmk_firmware/pull/8957 "Migrate `ACTION_MODS_ONESHOT` to `OSM()`"), [#8958](https://github.com/qmk/qmk_firmware/pull/8958 "Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()`"), [#8959](https://github.com/qmk/qmk_firmware/pull/8959 "Migrate `ACTION_LAYER_MODS` to `LM()`"), [#8968](https://github.com/qmk/qmk_firmware/pull/8968 "Migrate `ACTION_MODS_TAP_KEY` to `MT()`"), [#8977](https://github.com/qmk/qmk_firmware/pull/8977 "Migrate miscellaneous `fn_actions` entries"), and [#8979](https://github.com/qmk/qmk_firmware/pull/8979 "Migrate `ACTION_MODS_KEY` to chained mod keycodes") From c67f7fec62a190319e01a7938a5156cb84207c1d Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Thu, 14 May 2020 12:14:43 -0700 Subject: [PATCH 16/30] Add notes for 8974 --- docs/ChangeLog/20200530/01_core_changes.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/ChangeLog/20200530/01_core_changes.md b/docs/ChangeLog/20200530/01_core_changes.md index f62cc5ccb76c..670a002a80e8 100644 --- a/docs/ChangeLog/20200530/01_core_changes.md +++ b/docs/ChangeLog/20200530/01_core_changes.md @@ -53,8 +53,10 @@ Fork all QMK submodules to protect against upstream repositories disappearing. ### fixing wrong configuration of AUDIO feature -[#8903](https://github.com/qmk/qmk_firmware/pull/8903) +[#8903](https://github.com/qmk/qmk_firmware/pull/8903) and [#8974](https://github.com/qmk/qmk_firmware/pull/8974) `audio_avr.c` does not default to any pin; there has to be a #define XX_AUDIO in config.h at some level for Audio to actually work. Otherwise, the Audio code ends up cluttering the firmware, possibly breaking builds because the maximum allowed firmware size is exceeded. These changes fix this by disabling Audio on keyboards that have the feature misconfigured, and therefore non-functional. + +Also, add a compile-time error to alert the user to a missing pin-configuration (on AVR boards) when `AUDIO_ENABLE = yes` is set. From d084ed3fa1acc2298234dff762e96bc53ea90c84 Mon Sep 17 00:00:00 2001 From: zvecr Date: Thu, 14 May 2020 22:02:25 +0100 Subject: [PATCH 17/30] Add notes on 8269 --- docs/ChangeLog/20200530/01_core_changes.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/ChangeLog/20200530/01_core_changes.md b/docs/ChangeLog/20200530/01_core_changes.md index 670a002a80e8..fc487edb3847 100644 --- a/docs/ChangeLog/20200530/01_core_changes.md +++ b/docs/ChangeLog/20200530/01_core_changes.md @@ -26,7 +26,15 @@ This is the last release of QMK that will work without having Python 3.6 (or lat After the next breaking change you will not be able to build if `bin/qmk hello` does not work. -### [#8269] +### + +### Upgrade from tinyprintf to mpaland/printf + +[#8269](https://github.com/qmk/qmk_firmware/pull/8269) + +- Provides debug functionality on ChibiOS/ARM that more compliant than previous integrations. +- Less maintenence, fewer QMK customisations, and allow QMK to sidestep previous compile and runtime issues. +- A `make git-submodule` may be required after pulling the latest QMK firmware code to update to the new dependency. ### Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup From 265eb68bce2cf5f72958959b64aa5143626a160f Mon Sep 17 00:00:00 2001 From: zvecr Date: Thu, 14 May 2020 22:20:45 +0100 Subject: [PATCH 18/30] Add notes on 8269 - fix redundant heading --- docs/ChangeLog/20200530/01_core_changes.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/ChangeLog/20200530/01_core_changes.md b/docs/ChangeLog/20200530/01_core_changes.md index fc487edb3847..01e1a290dc9c 100644 --- a/docs/ChangeLog/20200530/01_core_changes.md +++ b/docs/ChangeLog/20200530/01_core_changes.md @@ -26,8 +26,6 @@ This is the last release of QMK that will work without having Python 3.6 (or lat After the next breaking change you will not be able to build if `bin/qmk hello` does not work. -### - ### Upgrade from tinyprintf to mpaland/printf [#8269](https://github.com/qmk/qmk_firmware/pull/8269) From 874ce6f43bef311789c24760c99a590831a8942a Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Thu, 14 May 2020 14:43:27 -0700 Subject: [PATCH 19/30] Grammar fixes for 8269 notes --- docs/ChangeLog/20200530/01_core_changes.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/ChangeLog/20200530/01_core_changes.md b/docs/ChangeLog/20200530/01_core_changes.md index 01e1a290dc9c..1fe138cbf2ec 100644 --- a/docs/ChangeLog/20200530/01_core_changes.md +++ b/docs/ChangeLog/20200530/01_core_changes.md @@ -30,9 +30,9 @@ After the next breaking change you will not be able to build if `bin/qmk hello` [#8269](https://github.com/qmk/qmk_firmware/pull/8269) -- Provides debug functionality on ChibiOS/ARM that more compliant than previous integrations. -- Less maintenence, fewer QMK customisations, and allow QMK to sidestep previous compile and runtime issues. -- A `make git-submodule` may be required after pulling the latest QMK firmware code to update to the new dependency. +- Provides debug functionality on ChibiOS/ARM that is more compliant than previous integrations. +- Less maintenence, fewer QMK customisations, and allows QMK to sidestep previous compile and runtime issues. +- A `make git-submodule` may be required after pulling the latest QMK Firmware code to update to the new dependency. ### Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup From dad49c43827b328c00c8d9c74aaec76b5dd00782 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Thu, 14 May 2020 21:55:29 -0700 Subject: [PATCH 20/30] Concatenate the ChangeLog sections into one file --- docs/ChangeLog/20200530.md | 225 ++++++++++++++++++ docs/ChangeLog/20200530/01_core_changes.md | 68 ------ .../20200530/02_keyboard_refactors.md | 113 --------- docs/ChangeLog/20200530/03_keyboard_moves.md | 22 -- .../20200530/04_keycode_migrations.md | 15 -- 5 files changed, 225 insertions(+), 218 deletions(-) create mode 100644 docs/ChangeLog/20200530.md delete mode 100644 docs/ChangeLog/20200530/01_core_changes.md delete mode 100644 docs/ChangeLog/20200530/02_keyboard_refactors.md delete mode 100644 docs/ChangeLog/20200530/03_keyboard_moves.md delete mode 100644 docs/ChangeLog/20200530/04_keycode_migrations.md diff --git a/docs/ChangeLog/20200530.md b/docs/ChangeLog/20200530.md new file mode 100644 index 000000000000..4b486f3be5f8 --- /dev/null +++ b/docs/ChangeLog/20200530.md @@ -0,0 +1,225 @@ +# QMK Breaking Change - 2020 Feb 29 Changelog + +Four times a year QMK runs a process for merging Breaking Changes. A Breaking Change is any change which modifies how QMK behaves in a way that is incompatible or potentially dangerous. We limit these changes to 4 times per year so that users can have confidence that updating their QMK tree will not break their keymaps. + +The list of changes follows. + + +## Core Changes + +### Converting V-USB usbdrv to a submodule + +[#8321](https://github.com/qmk/qmk_firmware/pull/8321) and [qmk_compiler#62](https://github.com/qmk/qmk_compiler/pull/62). + +These PRs move the V-USB driver code out of the qmk_firmware repository and into a submodule pointed at https://github.com/obdev/v-usb. This will make it easier to update the codebase if needed, while applying any potential QMK-specific modifications by forking it to the QMK GitHub organization. + +### Unify Tap Hold functions and documentation + +[#8348](https://github.com/qmk/qmk_firmware/pull/8348) + +Updates all of the per key tap-hold functions to pass the `keyrecord_t` structure, and include documentation changes. + +Any remaining versions or code outside of the main repo will need to be converted: +| Old function | New Function | +|------------------------------------------------------|---------------------------------------------------------------------------| +|`uint16_t get_tapping_term(uint16_t keycode)` |`uint16_t get_tapping_term(uint16_t keycode, keyrecord_t *record)` | +|`bool get_ignore_mod_tap_interrupt(uint16_t keycode)` |`bool get_ignore_mod_tap_interrupt(uint16_t keycode, keyrecord_t *record)` | + +### Python Required In The Build Process + +[#9000](https://github.com/qmk/qmk_firmware/pull/9000) + +This is the last release of QMK that will work without having Python 3.6 (or later) installed. If your environment is not fully setup you will get a warning instructing you to set it up. + +After the next breaking change you will not be able to build if `bin/qmk hello` does not work. + +### Upgrade from tinyprintf to mpaland/printf + +[#8269](https://github.com/qmk/qmk_firmware/pull/8269) + +- Provides debug functionality on ChibiOS/ARM that is more compliant than previous integrations. +- Less maintenence, fewer QMK customisations, and allows QMK to sidestep previous compile and runtime issues. +- A `make git-submodule` may be required after pulling the latest QMK Firmware code to update to the new dependency. + +### Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup + +[#6480](https://github.com/qmk/qmk_firmware/pull/6480) + +- Changes `RGB_DISABLE_AFTER_TIMEOUT` to be based on milliseconds instead of ticks. +- Includes a code cleanup, resulting in a savings of 100 bytes, depending on features used. +- Fixed issues with timeouts / suspending at the wrong time not turning off all LEDs in some cases. + +The `RGB_DISABLE_AFTER_TIMEOUT` definition is now deprecated, and has been superseded by `RGB_DISABLE_TIMEOUT`. To use the new definition, rename `RGB_DISABLE_AFTER_TIMEOUT` to `RGB_DISABLE_TIMEOUT` in your `config.h` file, and multiply the value set by 1200. + +Before: `#define RGB_DISABLE_AFTER_TIMEOUT 100` +After: `#define RGB_DISABLE_TIMEOUT 120000` + +### Switch to qmk forks for everything + +[#9019](https://github.com/qmk/qmk_firmware/pull/9019) + +Fork all QMK submodules to protect against upstream repositories disappearing. + +### code cleanup regarding deprecated macro PLAY_NOTE_ARRAY by replacing it with PLAY_SONG + +[#8484](https://github.com/qmk/qmk_firmware/pull/8484) + +### fixing wrong configuration of AUDIO feature + +[#8903](https://github.com/qmk/qmk_firmware/pull/8903) and [#8974](https://github.com/qmk/qmk_firmware/pull/8974) + +`audio_avr.c` does not default to any pin; there has to be a #define XX_AUDIO in config.h at some level for Audio to actually work. Otherwise, the Audio code ends up cluttering the firmware, possibly breaking builds because the maximum allowed firmware size is exceeded. + +These changes fix this by disabling Audio on keyboards that have the feature misconfigured, and therefore non-functional. + +Also, add a compile-time error to alert the user to a missing pin-configuration (on AVR boards) when `AUDIO_ENABLE = yes` is set. +## Keyboard Refactors + +### Migrating Lily58 to use split_common + +[#6260](https://github.com/qmk/qmk_firmware/pull/6260) Modifies the default firmware for Lily58 to use the `split_common` library, instead of including and depending on its own set of libraries for the following functionality: +- SSD1306 display +- i2c for OLED +- Serial Communication + +This allows current lily58 firmware to advance with updates to the `split_common` library, which is shared with many other split keyboards. + +#### To migrate existing Lily58 firmware: + +[Changes to `config.h`](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-445ac369c8717dcd6fc6fc3630836fc1): +- Remove `#define SSD1306OLED` from config.h + + +[Changes to `keymap.c`](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7): +- Find/Replace each instance of `#ifdef SSD1306OLED` with `#ifdef OLED_DRIVER_ENABLE` +- The following changes are for compatibility with the OLED driver. If you don't use the OLED driver you may safely delete [this section](https://github.com/qmk/qmk_firmware/blob/e6b9980bd45c186f7360df68c24b6e05a80c10dc/keyboards/lily58/keymaps/default/keymap.c#L144-L190) +- Alternatively, if you did not change the OLED code from that in `default`, you may find it easier to simply copy the [relevant section](https://github.com/qmk/qmk_firmware/blob/4ac310668501ae6786c711ecc8f01f62ddaa1c0b/keyboards/lily58/keymaps/default/keymap.c#L138-L172). Otherwise, the changes you need to make are as follows (sample change [here](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7R138-R173)) +- [Remove](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7L138-L141) the block +```c +#ifdef SSD1306OLED + iota_gfx_init(!has_usb()); // turns on the display +#endif +``` +- Within the block bounded by `#ifdef OLED_DRIVER_ENABLE` and `#endif // OLED_DRIVER_ENABLE`, add the following block to ensure that your two OLEDs are rotated correctly across the left and right sides: +```c +oled_rotation_t oled_init_user(oled_rotation_t rotation) { + if (!is_keyboard_master()) + return OLED_ROTATION_180; // flips the display 180 degrees if offhand + return rotation; +} +``` +- Remove the functions `matrix_scan_user`, `matrix_update` and `iota_gfx_task_user` +- Find/Replace `matrix_render_user(struct CharacterMatrix *matrix)` with `iota_gfx_task_user(void)` +- Find/Replace `is_master` with `is_keyboard_master()` +- For each instance of `matrix_write_ln(matrix, display_fn())`, rewrite it as `oled_write_ln(read_layer_state(), false);` +- For each instance of `matrix_write(matrix, read_logo());`, replace with `oled_write(read_logo(), false);` + +### Refactor zinc to use split_common + +[#7114](https://github.com/qmk/qmk_firmware/pull/7114) + +* Refactor to use split_common and remove split codes under the zinc/revx/ +* Add - backlight RGB LED and/or underglow RGB LED option +* Add - continuous RGB animations feature (between L and R halves) +* Fix - keymap files to adapt to changes + * all authors of keymaps confirmed this PR +* Update - documents and rules.mk + +### Refactor of TKC1800 to use common OLED code + +[#8472](https://github.com/qmk/qmk_firmware/pull/8472) Modifies the default firmware for TKC1800 to use the in-built I2C and OLED drivers, instead of including and depending on its own set of libraries for the following functionality: +- SSD1306 display +- i2c for OLED + +This allows current TKC1800 firmware to advance with updates to those drivers, which are shared with other keyboards. + +#### To migrate existing TKC1800 firmware: + +[Changes to `config.h`](https://github.com/qmk/qmk_firmware/pull/8472/files#diff-d10b26e676b4a55cbb00d71955116526): +- Remove `#define SSD1306OLED` from config.h + +[Changes to `tkc1800.c`](https://github.com/qmk/qmk_firmware/pull/8472/files#diff-3b35bd30abe89c8110717c6972cd2cc5): +- Add the following to avoid debug errors on HID_listen if the screen is not present +```c +void keyboard_pre_init_kb(void) { + setPinInputHigh(D0); + setPinInputHigh(D1); + + keyboard_pre_init_user(); +} +``` + +[Changes to `keymap.c`](https://github.com/qmk/qmk_firmware/pull/8472/files#diff-05a2a344ce27e4d045fe68520ccd4771): +- Find/Replace each instance of `#ifdef SSD1306OLED` with `#ifdef OLED_DRIVER_ENABLE` +- The following changes are for compatibility with the OLED driver. If you don't use the OLED driver you may safely delete [this section](https://github.com/qmk/qmk_firmware/blob/e6b9980bd45c186f7360df68c24b6e05a80c10dc/keyboards/lily58/keymaps/default/keymap.c#L144-L190) +- [Remove](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7L91-L158) the block +```c +#ifdef SSD1306OLED + iota_gfx_init(!has_usb()); // turns on the display +#endif +``` +- Within the block bounded by `#ifdef OLED_DRIVER_ENABLE` and `#endif // OLED_DRIVER_ENABLE`, add the following block to ensure that your two OLEDs are rotated correctly across the left and right sides: +```c +oled_rotation_t oled_init_user(oled_rotation_t rotation) { + if (!is_keyboard_master()) + return OLED_ROTATION_180; // flips the display 180 degrees if offhand + return rotation; +} +``` +- Remove the function `iota_gfx_task_user` + +### Split HHKB to ANSI and JP layouts and Add VIA support for each + +[#8582](https://github.com/qmk/qmk_firmware/pull/8582) + +- Splits the HHKB codebase into two separate folders `keyboards/hhkb/ansi` and `keyboards/hhkb/jp`. +- Adds VIA Configurator support for both versions. + +#### Migrating existing HHKB keymaps + +- Remove any checks for the `HHKB_JP` definition + - All checks for this definition have been removed, and each version uses the source that is appropriate to that version. +- Move the directory for your keymap into the appropriate `keymaps` directory + - `keyboards/hhkb/ansi/keymaps/` for ANSI HHKBs + - `keyboards/hhkb/jp/keymaps/` for HHKB JPs +- Compile with the new keyboard names + - This PR changes the compilation instructions for the HHKB Alternate Controller. To compile firmware for this controller moving forward, use: + - `make hhkb/ansi` for ANSI-layout HHKBs + - `make hhkb/jp` for HHKB JP keyboards +## Keyboard Moves + +- [#8412](https://github.com/qmk/qmk_firmware/pull/8412 "Changing board names to prevent confusion") by blindassassin111 +- [#8499](https://github.com/qmk/qmk_firmware/pull/8499 "Move the Keyboardio Model01 to a keyboardio/ subdir") by algernon +- [#8830](https://github.com/qmk/qmk_firmware/pull/8830 "Move spaceman keyboards") by Spaceman (formerly known as Rionlion100) +- [#8537](https://github.com/qmk/qmk_firmware/pull/8537 "Organizing my keyboards (plaid, tartan, ergoinu)") by hsgw + +Keyboards by Keyboardio, Spaceman (formerly Rionlion100), and hsgw move to vendor folders, while PCBs designed by blindassassin111 are renamed. + +Old Name | New Name +:----------------- | :----------------- +2_milk | spaceman/2_milk +at101_blackheart | at101_bh +ergoinu | dm9records/ergoinu +model01 | keyboardio/model01 +omnikey_blackheart | omnikey_bh +pancake | spaceman/pancake +plaid | dm9records/plaid +tartan | dm9records/tartan +z150_blackheart | z150_bh + +If you own one of these PCBs, please use the new names to compile your firmware moving forward. +## Keycode Migration PRs + +[#8954](https://github.com/qmk/qmk_firmware/pull/8954 "Migrate `ACTION_LAYER_TOGGLE` to `TG()`"), [#8957](https://github.com/qmk/qmk_firmware/pull/8957 "Migrate `ACTION_MODS_ONESHOT` to `OSM()`"), [#8958](https://github.com/qmk/qmk_firmware/pull/8958 "Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()`"), [#8959](https://github.com/qmk/qmk_firmware/pull/8959 "Migrate `ACTION_LAYER_MODS` to `LM()`"), [#8968](https://github.com/qmk/qmk_firmware/pull/8968 "Migrate `ACTION_MODS_TAP_KEY` to `MT()`"), [#8977](https://github.com/qmk/qmk_firmware/pull/8977 "Migrate miscellaneous `fn_actions` entries"), and [#8979](https://github.com/qmk/qmk_firmware/pull/8979 "Migrate `ACTION_MODS_KEY` to chained mod keycodes") + +Authored by fauxpark, these pull requests remove references to deprecated TMK macros that have been superseded by native QMK keycodes. + +Old `fn_actions` action | New QMK keycode +:---------------------- | :-------------- +`ACTION_DEFAULT_LAYER_SET(layer)` | `DF(layer)` +`ACTION_LAYER_MODS(layer, mod)` | `LM(layer, mod)` +`ACTION_LAYER_ONESHOT(mod)` | `OSL(mod)` +`ACTION_LAYER_TOGGLE(layer)` | `TG(layer)` +`ACTION_MODS_ONESHOT(mod)` | `OSM(mod)` +`ACTION_MODS_TAP_KEY(mod, kc)` | `MT(mod, kc)` +`ACTION_MODS_KEY(mod, kc)`
e.g. `ACTION_MODS_KEY(MOD_LCTL, KC_0)` | `MOD(kc)`
e.g. `LCTL(KC_0)` diff --git a/docs/ChangeLog/20200530/01_core_changes.md b/docs/ChangeLog/20200530/01_core_changes.md deleted file mode 100644 index 1fe138cbf2ec..000000000000 --- a/docs/ChangeLog/20200530/01_core_changes.md +++ /dev/null @@ -1,68 +0,0 @@ -## Core Changes - -### Converting V-USB usbdrv to a submodule - -[#8321](https://github.com/qmk/qmk_firmware/pull/8321) and [qmk_compiler#62](https://github.com/qmk/qmk_compiler/pull/62). - -These PRs move the V-USB driver code out of the qmk_firmware repository and into a submodule pointed at https://github.com/obdev/v-usb. This will make it easier to update the codebase if needed, while applying any potential QMK-specific modifications by forking it to the QMK GitHub organization. - -### Unify Tap Hold functions and documentation - -[#8348](https://github.com/qmk/qmk_firmware/pull/8348) - -Updates all of the per key tap-hold functions to pass the `keyrecord_t` structure, and include documentation changes. - -Any remaining versions or code outside of the main repo will need to be converted: -| Old function | New Function | -|------------------------------------------------------|---------------------------------------------------------------------------| -|`uint16_t get_tapping_term(uint16_t keycode)` |`uint16_t get_tapping_term(uint16_t keycode, keyrecord_t *record)` | -|`bool get_ignore_mod_tap_interrupt(uint16_t keycode)` |`bool get_ignore_mod_tap_interrupt(uint16_t keycode, keyrecord_t *record)` | - -### Python Required In The Build Process - -[#9000](https://github.com/qmk/qmk_firmware/pull/9000) - -This is the last release of QMK that will work without having Python 3.6 (or later) installed. If your environment is not fully setup you will get a warning instructing you to set it up. - -After the next breaking change you will not be able to build if `bin/qmk hello` does not work. - -### Upgrade from tinyprintf to mpaland/printf - -[#8269](https://github.com/qmk/qmk_firmware/pull/8269) - -- Provides debug functionality on ChibiOS/ARM that is more compliant than previous integrations. -- Less maintenence, fewer QMK customisations, and allows QMK to sidestep previous compile and runtime issues. -- A `make git-submodule` may be required after pulling the latest QMK Firmware code to update to the new dependency. - -### Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup - -[#6480](https://github.com/qmk/qmk_firmware/pull/6480) - -- Changes `RGB_DISABLE_AFTER_TIMEOUT` to be based on milliseconds instead of ticks. -- Includes a code cleanup, resulting in a savings of 100 bytes, depending on features used. -- Fixed issues with timeouts / suspending at the wrong time not turning off all LEDs in some cases. - -The `RGB_DISABLE_AFTER_TIMEOUT` definition is now deprecated, and has been superseded by `RGB_DISABLE_TIMEOUT`. To use the new definition, rename `RGB_DISABLE_AFTER_TIMEOUT` to `RGB_DISABLE_TIMEOUT` in your `config.h` file, and multiply the value set by 1200. - -Before: `#define RGB_DISABLE_AFTER_TIMEOUT 100` -After: `#define RGB_DISABLE_TIMEOUT 120000` - -### Switch to qmk forks for everything - -[#9019](https://github.com/qmk/qmk_firmware/pull/9019) - -Fork all QMK submodules to protect against upstream repositories disappearing. - -### code cleanup regarding deprecated macro PLAY_NOTE_ARRAY by replacing it with PLAY_SONG - -[#8484](https://github.com/qmk/qmk_firmware/pull/8484) - -### fixing wrong configuration of AUDIO feature - -[#8903](https://github.com/qmk/qmk_firmware/pull/8903) and [#8974](https://github.com/qmk/qmk_firmware/pull/8974) - -`audio_avr.c` does not default to any pin; there has to be a #define XX_AUDIO in config.h at some level for Audio to actually work. Otherwise, the Audio code ends up cluttering the firmware, possibly breaking builds because the maximum allowed firmware size is exceeded. - -These changes fix this by disabling Audio on keyboards that have the feature misconfigured, and therefore non-functional. - -Also, add a compile-time error to alert the user to a missing pin-configuration (on AVR boards) when `AUDIO_ENABLE = yes` is set. diff --git a/docs/ChangeLog/20200530/02_keyboard_refactors.md b/docs/ChangeLog/20200530/02_keyboard_refactors.md deleted file mode 100644 index 93b3217e372e..000000000000 --- a/docs/ChangeLog/20200530/02_keyboard_refactors.md +++ /dev/null @@ -1,113 +0,0 @@ -## Keyboard Refactors - -### Migrating Lily58 to use split_common - -[#6260](https://github.com/qmk/qmk_firmware/pull/6260) Modifies the default firmware for Lily58 to use the `split_common` library, instead of including and depending on its own set of libraries for the following functionality: -- SSD1306 display -- i2c for OLED -- Serial Communication - -This allows current lily58 firmware to advance with updates to the `split_common` library, which is shared with many other split keyboards. - -#### To migrate existing Lily58 firmware: - -[Changes to `config.h`](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-445ac369c8717dcd6fc6fc3630836fc1): -- Remove `#define SSD1306OLED` from config.h - - -[Changes to `keymap.c`](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7): -- Find/Replace each instance of `#ifdef SSD1306OLED` with `#ifdef OLED_DRIVER_ENABLE` -- The following changes are for compatibility with the OLED driver. If you don't use the OLED driver you may safely delete [this section](https://github.com/qmk/qmk_firmware/blob/e6b9980bd45c186f7360df68c24b6e05a80c10dc/keyboards/lily58/keymaps/default/keymap.c#L144-L190) -- Alternatively, if you did not change the OLED code from that in `default`, you may find it easier to simply copy the [relevant section](https://github.com/qmk/qmk_firmware/blob/4ac310668501ae6786c711ecc8f01f62ddaa1c0b/keyboards/lily58/keymaps/default/keymap.c#L138-L172). Otherwise, the changes you need to make are as follows (sample change [here](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7R138-R173)) -- [Remove](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7L138-L141) the block -```c -#ifdef SSD1306OLED - iota_gfx_init(!has_usb()); // turns on the display -#endif -``` -- Within the block bounded by `#ifdef OLED_DRIVER_ENABLE` and `#endif // OLED_DRIVER_ENABLE`, add the following block to ensure that your two OLEDs are rotated correctly across the left and right sides: -```c -oled_rotation_t oled_init_user(oled_rotation_t rotation) { - if (!is_keyboard_master()) - return OLED_ROTATION_180; // flips the display 180 degrees if offhand - return rotation; -} -``` -- Remove the functions `matrix_scan_user`, `matrix_update` and `iota_gfx_task_user` -- Find/Replace `matrix_render_user(struct CharacterMatrix *matrix)` with `iota_gfx_task_user(void)` -- Find/Replace `is_master` with `is_keyboard_master()` -- For each instance of `matrix_write_ln(matrix, display_fn())`, rewrite it as `oled_write_ln(read_layer_state(), false);` -- For each instance of `matrix_write(matrix, read_logo());`, replace with `oled_write(read_logo(), false);` - -### Refactor zinc to use split_common - -[#7114](https://github.com/qmk/qmk_firmware/pull/7114) - -* Refactor to use split_common and remove split codes under the zinc/revx/ -* Add - backlight RGB LED and/or underglow RGB LED option -* Add - continuous RGB animations feature (between L and R halves) -* Fix - keymap files to adapt to changes - * all authors of keymaps confirmed this PR -* Update - documents and rules.mk - -### Refactor of TKC1800 to use common OLED code - -[#8472](https://github.com/qmk/qmk_firmware/pull/8472) Modifies the default firmware for TKC1800 to use the in-built I2C and OLED drivers, instead of including and depending on its own set of libraries for the following functionality: -- SSD1306 display -- i2c for OLED - -This allows current TKC1800 firmware to advance with updates to those drivers, which are shared with other keyboards. - -#### To migrate existing TKC1800 firmware: - -[Changes to `config.h`](https://github.com/qmk/qmk_firmware/pull/8472/files#diff-d10b26e676b4a55cbb00d71955116526): -- Remove `#define SSD1306OLED` from config.h - -[Changes to `tkc1800.c`](https://github.com/qmk/qmk_firmware/pull/8472/files#diff-3b35bd30abe89c8110717c6972cd2cc5): -- Add the following to avoid debug errors on HID_listen if the screen is not present -```c -void keyboard_pre_init_kb(void) { - setPinInputHigh(D0); - setPinInputHigh(D1); - - keyboard_pre_init_user(); -} -``` - -[Changes to `keymap.c`](https://github.com/qmk/qmk_firmware/pull/8472/files#diff-05a2a344ce27e4d045fe68520ccd4771): -- Find/Replace each instance of `#ifdef SSD1306OLED` with `#ifdef OLED_DRIVER_ENABLE` -- The following changes are for compatibility with the OLED driver. If you don't use the OLED driver you may safely delete [this section](https://github.com/qmk/qmk_firmware/blob/e6b9980bd45c186f7360df68c24b6e05a80c10dc/keyboards/lily58/keymaps/default/keymap.c#L144-L190) -- [Remove](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7L91-L158) the block -```c -#ifdef SSD1306OLED - iota_gfx_init(!has_usb()); // turns on the display -#endif -``` -- Within the block bounded by `#ifdef OLED_DRIVER_ENABLE` and `#endif // OLED_DRIVER_ENABLE`, add the following block to ensure that your two OLEDs are rotated correctly across the left and right sides: -```c -oled_rotation_t oled_init_user(oled_rotation_t rotation) { - if (!is_keyboard_master()) - return OLED_ROTATION_180; // flips the display 180 degrees if offhand - return rotation; -} -``` -- Remove the function `iota_gfx_task_user` - -### Split HHKB to ANSI and JP layouts and Add VIA support for each - -[#8582](https://github.com/qmk/qmk_firmware/pull/8582) - -- Splits the HHKB codebase into two separate folders `keyboards/hhkb/ansi` and `keyboards/hhkb/jp`. -- Adds VIA Configurator support for both versions. - -#### Migrating existing HHKB keymaps - -- Remove any checks for the `HHKB_JP` definition - - All checks for this definition have been removed, and each version uses the source that is appropriate to that version. -- Move the directory for your keymap into the appropriate `keymaps` directory - - `keyboards/hhkb/ansi/keymaps/` for ANSI HHKBs - - `keyboards/hhkb/jp/keymaps/` for HHKB JPs -- Compile with the new keyboard names - - This PR changes the compilation instructions for the HHKB Alternate Controller. To compile firmware for this controller moving forward, use: - - `make hhkb/ansi` for ANSI-layout HHKBs - - `make hhkb/jp` for HHKB JP keyboards diff --git a/docs/ChangeLog/20200530/03_keyboard_moves.md b/docs/ChangeLog/20200530/03_keyboard_moves.md deleted file mode 100644 index 969b4ace112f..000000000000 --- a/docs/ChangeLog/20200530/03_keyboard_moves.md +++ /dev/null @@ -1,22 +0,0 @@ -## Keyboard Moves - -- [#8412](https://github.com/qmk/qmk_firmware/pull/8412 "Changing board names to prevent confusion") by blindassassin111 -- [#8499](https://github.com/qmk/qmk_firmware/pull/8499 "Move the Keyboardio Model01 to a keyboardio/ subdir") by algernon -- [#8830](https://github.com/qmk/qmk_firmware/pull/8830 "Move spaceman keyboards") by Spaceman (formerly known as Rionlion100) -- [#8537](https://github.com/qmk/qmk_firmware/pull/8537 "Organizing my keyboards (plaid, tartan, ergoinu)") by hsgw - -Keyboards by Keyboardio, Spaceman (formerly Rionlion100), and hsgw move to vendor folders, while PCBs designed by blindassassin111 are renamed. - -Old Name | New Name -:----------------- | :----------------- -2_milk | spaceman/2_milk -at101_blackheart | at101_bh -ergoinu | dm9records/ergoinu -model01 | keyboardio/model01 -omnikey_blackheart | omnikey_bh -pancake | spaceman/pancake -plaid | dm9records/plaid -tartan | dm9records/tartan -z150_blackheart | z150_bh - -If you own one of these PCBs, please use the new names to compile your firmware moving forward. diff --git a/docs/ChangeLog/20200530/04_keycode_migrations.md b/docs/ChangeLog/20200530/04_keycode_migrations.md deleted file mode 100644 index 02ea61f7bbb9..000000000000 --- a/docs/ChangeLog/20200530/04_keycode_migrations.md +++ /dev/null @@ -1,15 +0,0 @@ -## Keycode Migration PRs - -[#8954](https://github.com/qmk/qmk_firmware/pull/8954 "Migrate `ACTION_LAYER_TOGGLE` to `TG()`"), [#8957](https://github.com/qmk/qmk_firmware/pull/8957 "Migrate `ACTION_MODS_ONESHOT` to `OSM()`"), [#8958](https://github.com/qmk/qmk_firmware/pull/8958 "Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()`"), [#8959](https://github.com/qmk/qmk_firmware/pull/8959 "Migrate `ACTION_LAYER_MODS` to `LM()`"), [#8968](https://github.com/qmk/qmk_firmware/pull/8968 "Migrate `ACTION_MODS_TAP_KEY` to `MT()`"), [#8977](https://github.com/qmk/qmk_firmware/pull/8977 "Migrate miscellaneous `fn_actions` entries"), and [#8979](https://github.com/qmk/qmk_firmware/pull/8979 "Migrate `ACTION_MODS_KEY` to chained mod keycodes") - -Authored by fauxpark, these pull requests remove references to deprecated TMK macros that have been superseded by native QMK keycodes. - -Old `fn_actions` action | New QMK keycode -:---------------------- | :-------------- -`ACTION_DEFAULT_LAYER_SET(layer)` | `DF(layer)` -`ACTION_LAYER_MODS(layer, mod)` | `LM(layer, mod)` -`ACTION_LAYER_ONESHOT(mod)` | `OSL(mod)` -`ACTION_LAYER_TOGGLE(layer)` | `TG(layer)` -`ACTION_MODS_ONESHOT(mod)` | `OSM(mod)` -`ACTION_MODS_TAP_KEY(mod, kc)` | `MT(mod, kc)` -`ACTION_MODS_KEY(mod, kc)`
e.g. `ACTION_MODS_KEY(MOD_LCTL, KC_0)` | `MOD(kc)`
e.g. `LCTL(KC_0)` From f49e9f291b15d2c56e9f0de6e393dd275ca6bef5 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Tue, 26 May 2020 04:08:46 -0700 Subject: [PATCH 21/30] minor changelog formatting Add some line breaks so the sections are consistent to each other. --- docs/ChangeLog/20200530.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/ChangeLog/20200530.md b/docs/ChangeLog/20200530.md index 4b486f3be5f8..8422e00a71ce 100644 --- a/docs/ChangeLog/20200530.md +++ b/docs/ChangeLog/20200530.md @@ -77,7 +77,10 @@ Also, add a compile-time error to alert the user to a missing pin-configuration ### Migrating Lily58 to use split_common -[#6260](https://github.com/qmk/qmk_firmware/pull/6260) Modifies the default firmware for Lily58 to use the `split_common` library, instead of including and depending on its own set of libraries for the following functionality: +[#6260](https://github.com/qmk/qmk_firmware/pull/6260) + +Modifies the default firmware for Lily58 to use the `split_common` library, instead of including and depending on its own set of libraries for the following functionality: + - SSD1306 display - i2c for OLED - Serial Communication @@ -127,7 +130,10 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) { ### Refactor of TKC1800 to use common OLED code -[#8472](https://github.com/qmk/qmk_firmware/pull/8472) Modifies the default firmware for TKC1800 to use the in-built I2C and OLED drivers, instead of including and depending on its own set of libraries for the following functionality: +[#8472](https://github.com/qmk/qmk_firmware/pull/8472) + +Modifies the default firmware for TKC1800 to use the in-built I2C and OLED drivers, instead of including and depending on its own set of libraries for the following functionality: + - SSD1306 display - i2c for OLED From de1b135b94ffe6dbd00f6e09cd3e66ae39173693 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Tue, 26 May 2020 04:09:31 -0700 Subject: [PATCH 22/30] link 7114 bugfix pr --- docs/ChangeLog/20200530.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ChangeLog/20200530.md b/docs/ChangeLog/20200530.md index 8422e00a71ce..b8cdd4f1fc5b 100644 --- a/docs/ChangeLog/20200530.md +++ b/docs/ChangeLog/20200530.md @@ -119,7 +119,7 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) { ### Refactor zinc to use split_common -[#7114](https://github.com/qmk/qmk_firmware/pull/7114) +[#7114](https://github.com/qmk/qmk_firmware/pull/7114) and [#9171](https://github.com/qmk/qmk_firmware/pull/9171) * Refactor to use split_common and remove split codes under the zinc/revx/ * Add - backlight RGB LED and/or underglow RGB LED option From eb69c17776a4fc0c3f1d6e1fe8b2287cfdce3140 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Tue, 26 May 2020 09:58:07 -0700 Subject: [PATCH 23/30] add detail for PR8484 --- docs/ChangeLog/20200530.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/ChangeLog/20200530.md b/docs/ChangeLog/20200530.md index b8cdd4f1fc5b..c4b704ce4554 100644 --- a/docs/ChangeLog/20200530.md +++ b/docs/ChangeLog/20200530.md @@ -64,6 +64,8 @@ Fork all QMK submodules to protect against upstream repositories disappearing. [#8484](https://github.com/qmk/qmk_firmware/pull/8484) +Removes the deprecated `PLAY_NOTE_ARRAY` macro. References to it are replaced with `PLAY_SONG`, which references the same function. + ### fixing wrong configuration of AUDIO feature [#8903](https://github.com/qmk/qmk_firmware/pull/8903) and [#8974](https://github.com/qmk/qmk_firmware/pull/8974) From 34f0df078a964a3e12aaa265eab21334d8cee7d8 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Tue, 26 May 2020 10:36:58 -0700 Subject: [PATCH 24/30] remove redundancy regarding Spaceman's name in Keyboard Moves section --- docs/ChangeLog/20200530.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ChangeLog/20200530.md b/docs/ChangeLog/20200530.md index c4b704ce4554..fc31e08dd235 100644 --- a/docs/ChangeLog/20200530.md +++ b/docs/ChangeLog/20200530.md @@ -201,7 +201,7 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) { - [#8830](https://github.com/qmk/qmk_firmware/pull/8830 "Move spaceman keyboards") by Spaceman (formerly known as Rionlion100) - [#8537](https://github.com/qmk/qmk_firmware/pull/8537 "Organizing my keyboards (plaid, tartan, ergoinu)") by hsgw -Keyboards by Keyboardio, Spaceman (formerly Rionlion100), and hsgw move to vendor folders, while PCBs designed by blindassassin111 are renamed. +Keyboards by Keyboardio, Spaceman, and hsgw move to vendor folders, while PCBs designed by blindassassin111 are renamed. Old Name | New Name :----------------- | :----------------- From 398ce507ebbf5cce84cdecf89b4292fe3d3162de Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Tue, 26 May 2020 10:37:38 -0700 Subject: [PATCH 25/30] unify blank lines ahead of section headings --- docs/ChangeLog/20200530.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/ChangeLog/20200530.md b/docs/ChangeLog/20200530.md index fc31e08dd235..15073aed3b3e 100644 --- a/docs/ChangeLog/20200530.md +++ b/docs/ChangeLog/20200530.md @@ -75,6 +75,8 @@ Removes the deprecated `PLAY_NOTE_ARRAY` macro. References to it are replaced wi These changes fix this by disabling Audio on keyboards that have the feature misconfigured, and therefore non-functional. Also, add a compile-time error to alert the user to a missing pin-configuration (on AVR boards) when `AUDIO_ENABLE = yes` is set. + + ## Keyboard Refactors ### Migrating Lily58 to use split_common @@ -194,6 +196,8 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) { - This PR changes the compilation instructions for the HHKB Alternate Controller. To compile firmware for this controller moving forward, use: - `make hhkb/ansi` for ANSI-layout HHKBs - `make hhkb/jp` for HHKB JP keyboards + + ## Keyboard Moves - [#8412](https://github.com/qmk/qmk_firmware/pull/8412 "Changing board names to prevent confusion") by blindassassin111 @@ -216,6 +220,8 @@ tartan | dm9records/tartan z150_blackheart | z150_bh If you own one of these PCBs, please use the new names to compile your firmware moving forward. + + ## Keycode Migration PRs [#8954](https://github.com/qmk/qmk_firmware/pull/8954 "Migrate `ACTION_LAYER_TOGGLE` to `TG()`"), [#8957](https://github.com/qmk/qmk_firmware/pull/8957 "Migrate `ACTION_MODS_ONESHOT` to `OSM()`"), [#8958](https://github.com/qmk/qmk_firmware/pull/8958 "Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()`"), [#8959](https://github.com/qmk/qmk_firmware/pull/8959 "Migrate `ACTION_LAYER_MODS` to `LM()`"), [#8968](https://github.com/qmk/qmk_firmware/pull/8968 "Migrate `ACTION_MODS_TAP_KEY` to `MT()`"), [#8977](https://github.com/qmk/qmk_firmware/pull/8977 "Migrate miscellaneous `fn_actions` entries"), and [#8979](https://github.com/qmk/qmk_firmware/pull/8979 "Migrate `ACTION_MODS_KEY` to chained mod keycodes") From fc45e0b33054fdbace1b3539d26d2513f326aea7 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Tue, 26 May 2020 10:38:46 -0700 Subject: [PATCH 26/30] fix the ChangeLog date --- docs/ChangeLog/20200530.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ChangeLog/20200530.md b/docs/ChangeLog/20200530.md index 15073aed3b3e..9def9ae12350 100644 --- a/docs/ChangeLog/20200530.md +++ b/docs/ChangeLog/20200530.md @@ -1,4 +1,4 @@ -# QMK Breaking Change - 2020 Feb 29 Changelog +# QMK Breaking Change - 2020 May 30 Changelog Four times a year QMK runs a process for merging Breaking Changes. A Breaking Change is any change which modifies how QMK behaves in a way that is incompatible or potentially dangerous. We limit these changes to 4 times per year so that users can have confidence that updating their QMK tree will not break their keymaps. From 59a7549745cde5ac2a794d582b114471d376cc2a Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Tue, 26 May 2020 10:41:25 -0700 Subject: [PATCH 27/30] remove ChangeLog file for PR8974 Its contents are already integrated into the main ChangeLog. --- docs/ChangeLog/20200530/PR8974.md | 2 -- 1 file changed, 2 deletions(-) delete mode 100644 docs/ChangeLog/20200530/PR8974.md diff --git a/docs/ChangeLog/20200530/PR8974.md b/docs/ChangeLog/20200530/PR8974.md deleted file mode 100644 index 269636d1b1be..000000000000 --- a/docs/ChangeLog/20200530/PR8974.md +++ /dev/null @@ -1,2 +0,0 @@ -## fixing wrong configuration of AUDIO feature -add a compile-time error to alert the user to a missing pin-configuration (on AVR boards) when AUDIO_ENABLE=yes is set From d3ba3d51a70f2f43ea6fe7c97568fdb109f22106 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Tue, 26 May 2020 10:51:29 -0700 Subject: [PATCH 28/30] update Breaking Changes doc for 2020-05-30 merge - update timeline for next cycle (2020-08-29) - change references to `future` branch to `develop` branch --- docs/breaking_changes.md | 45 ++++++++++++++++++++-------------------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/docs/breaking_changes.md b/docs/breaking_changes.md index 12bc0db9dae9..d6ded00e75ab 100644 --- a/docs/breaking_changes.md +++ b/docs/breaking_changes.md @@ -6,27 +6,28 @@ The breaking change period is when we will merge PR's that change QMK in dangero ## What has been included in past Breaking Changes? +* [2020 May 30](ChangeLog/20200530.md) * [2020 Feb 29](ChangeLog/20200229.md) * [2019 Aug 30](ChangeLog/20190830.md) ## When is the next Breaking Change? -The next Breaking Change is scheduled for May 30, 2020. +The next Breaking Change is scheduled for Aug 29, 2020. ### Important Dates -* [x] 2020 Feb 29 - `future` is created. It will be rebased weekly. -* [ ] 2020 May 2 - `future` closed to new PR's. -* [ ] 2020 May 2 - Call for testers. -* [ ] 2020 May 28 - `master` is locked, no PR's merged. -* [ ] 2020 May 30 - Merge `future` to `master`. -* [ ] 2020 May 30 - `master` is unlocked. PR's can be merged again. +* [x] 2020 May 30 - `develop` is created. It will be rebased weekly. +* [ ] 2020 Aug 1 - `develop` closed to new PR's. +* [ ] 2020 Aug 1 - Call for testers. +* [ ] 2020 Aug 27 - `master` is locked, no PR's merged. +* [ ] 2020 Aug 29 - Merge `develop` to `master`. +* [ ] 2020 Aug 29 - `master` is unlocked. PR's can be merged again. ## What changes will be included? -To see a list of breaking change candidates you can look at the [`breaking_change` label](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+label%3Abreaking_change+is%3Apr). New changes might be added between now and when `future` is closed, and a PR with that label applied is not guaranteed to be merged. +To see a list of breaking change candidates you can look at the [`breaking_change` label](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+label%3Abreaking_change+is%3Apr). New changes might be added between now and when `develop` is closed, and a PR with that label applied is not guaranteed to be merged. -If you want your breaking change to be included in this round you need to create a PR with the `breaking_change` label and have it accepted before `future` closes. After `future` closes no new breaking changes will be accepted. +If you want your breaking change to be included in this round you need to create a PR with the `breaking_change` label and have it accepted before `develop` closes. After `develop` closes no new breaking changes will be accepted. Criteria for acceptance: @@ -37,9 +38,9 @@ Criteria for acceptance: This section documents various processes we use when running the Breaking Changes process. -## Rebase `future` from `master` +## Rebase `develop` from `master` -This is run every Friday while `future` is open. +This is run every Friday while `develop` is open. Process: @@ -47,31 +48,31 @@ Process: cd qmk_firmware git checkout master git pull --ff-only -git checkout future +git checkout develop git rebase master git push --force ``` -## Creating the `future` branch +## Creating the `develop` branch -This happens immediately after the previous `future` branch is merged. +This happens immediately after the previous `develop` branch is merged. * `qmk_firmware` git commands * [ ] `git checkout master` * [ ] `git pull --ff-only` - * [ ] `git checkout -b future` + * [ ] `git checkout -b develop` * [ ] Edit `readme.md` * [ ] Add a big notice at the top that this is a testing branch. * [ ] Include a link to this document * [ ] `git commit -m 'Branch point for Breaking Change'` * [ ] `git tag breakpoint___
` * [ ] `git tag ` # Prevent the breakpoint tag from confusing version incrementing - * [ ] `git push origin future` + * [ ] `git push origin develop` * [ ] `git push --tags` ## 4 Weeks Before Merge -* `future` is now closed to new PR's, only fixes for current PR's may be merged +* `develop` is now closed to new PR's, only fixes for current PR's may be merged * Post call for testers * [ ] Discord * [ ] GitHub PR @@ -94,15 +95,15 @@ This happens immediately after the previous `future` branch is merged. ## Day Of Merge * `qmk_firmware` git commands - * [ ] `git checkout future` + * [ ] `git checkout develop` * [ ] `git pull --ff-only` * [ ] `git rebase origin/master` * [ ] Edit `readme.md` - * [ ] Remove the notes about `future` + * [ ] Remove the notes about `develop` * [ ] Roll up the ChangeLog into one file. * [ ] `git commit -m 'Merge point for Breaking Change'` - * [ ] `git push origin future` + * [ ] `git push origin develop` * Github Actions - * [ ] Create a PR for `future` + * [ ] Create a PR for `develop` * [ ] Make sure travis comes back clean - * [ ] Merge `future` PR + * [ ] Merge `develop` PR From 150cedc126474a9c47f4924a9cf2a2193003ef26 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Tue, 26 May 2020 10:55:17 -0700 Subject: [PATCH 29/30] update Breaking Change Instructions doc for 2020-05-30 merge - change reference to `future` branch to `develop` branch --- docs/breaking_changes_instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/breaking_changes_instructions.md b/docs/breaking_changes_instructions.md index 3f2f93834f6c..d835671556d3 100644 --- a/docs/breaking_changes_instructions.md +++ b/docs/breaking_changes_instructions.md @@ -27,7 +27,7 @@ If you are contributing core code, and the only reason it needs to go through br We require submissions that go through the Breaking Change process to include a changelog entry. The entry should be a short summary of the changes your pull request makes – [each section here started as a changelog](ChangeLog/20190830.md "n.b. This should link to the 2019 Aug 30 Breaking Changes doc - @noroadsleft"). -Your changelog should be located at `docs/ChangeLog/YYYYMMDD/PR####.md`, where `YYYYMMDD` is the date on which QMK's breaking change branch – usually named `future` – will be merged into the `master` branch, and `####` is the number of your pull request. +Your changelog should be located at `docs/ChangeLog/YYYYMMDD/PR####.md`, where `YYYYMMDD` is the date on which QMK's breaking change branch – usually named `develop` – will be merged into the `master` branch, and `####` is the number of your pull request. If your submission requires action on the part of users, your changelog should instruct users what action(s) must be taken, or link to a location that does so. From 81e5af3982bdd71a7f89a95dcad132be4a456623 Mon Sep 17 00:00:00 2001 From: James Young <18669334+noroadsleft@users.noreply.github.com> Date: Tue, 26 May 2020 10:56:20 -0700 Subject: [PATCH 30/30] add 2020 May 30 ChangeLog to docs sidebar --- docs/_summary.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/_summary.md b/docs/_summary.md index 0e82ab4f0c8b..e4523e9d5120 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -114,6 +114,7 @@ * [Overview](breaking_changes.md) * [My Pull Request Was Flagged](breaking_changes_instructions.md) * History + * [2020 May 30](ChangeLog/20200530.md) * [2020 Feb 29](ChangeLog/20200229.md) * [2019 Aug 30](ChangeLog/20190830.md)