diff options
Diffstat (limited to 'docs/ChangeLog/20190830.md')
-rw-r--r-- | docs/ChangeLog/20190830.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/ChangeLog/20190830.md b/docs/ChangeLog/20190830.md new file mode 100644 index 000000000..88d7192cb --- /dev/null +++ b/docs/ChangeLog/20190830.md | |||
@@ -0,0 +1,47 @@ | |||
1 | # QMK Breaking Change - 2019 Aug 30 | ||
2 | |||
3 | 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. | ||
4 | |||
5 | This document marks the inaugural Breaking Change merge. A list of changes follows. | ||
6 | |||
7 | ## LUFA USB descriptor cleanup | ||
8 | |||
9 | * Some code cleanups related to the USB HID descriptors on AVR keyboards, to make them easier to read and understand | ||
10 | * More information: see https://github.com/qmk/qmk_firmware/pull/4871 | ||
11 | * No behaviour changes anticipated and no keymaps modified | ||
12 | |||
13 | ## Migrating `ACTION_LAYER_MOMENTARY()` entries in `fn_actions` to `MO()` keycodes | ||
14 | |||
15 | * `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()` | ||
16 | * The end result of removing this obsolete feature should result in a decent reduction in firmware size and code complexity | ||
17 | * All keymaps affected are recommended to switch away from `fn_actions` in favour of the [custom keycode](https://docs.qmk.fm/#/custom_quantum_functions) and [macro](https://docs.qmk.fm/#/feature_macros) features | ||
18 | |||
19 | ## Update Atreus to current code conventions | ||
20 | |||
21 | * Duplicate include guards have bypassed the expected header processing behavior | ||
22 | * All keymaps affected are recommended to remove duplication of `<keyboard>/config.h` to `<keyboard>/keymaps/<user>/config.h` and only provide overrides at the keymap level | ||
23 | |||
24 | ## Backport changes to keymap language files from ZSA fork | ||
25 | |||
26 | * Fixes an issue in the `keymap_br_abnt2.h` file that includes the wrong source (`keymap_common.h` instead of `keymap.h`) | ||
27 | * Updates the `keymap_swedish.h` file to be specific to swedish, and not just "nordic" in general. | ||
28 | * Any keymaps using this will need to remove `NO_*` and replace it with `SE_*`. | ||
29 | |||
30 | ## Update repo to use LUFA as a git submodule | ||
31 | |||
32 | * `/lib/LUFA` removed from the repo | ||
33 | * LUFA set as a submodule, pointing to qmk/lufa | ||
34 | * This should allow more flexibility with LUFA, and allow us to keep the sub-module up to date, a lot more easily. It was ~2 years out of date with no easy path to fix that. This prevents that from being an issue in the future | ||
35 | |||
36 | ## Migrating `ACTION_BACKLIGHT_*()` entries in `fn_actions` to `BL_` keycodes | ||
37 | |||
38 | * `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()` | ||
39 | * All keymaps using these actions have had the relevant `KC_FN*` keys replaced with the equivalent `BL_*` keys | ||
40 | * If you currently use `KC_FN*` you will need to replace `fn_actions` with the [custom keycode](https://docs.qmk.fm/#/custom_quantum_functions) and [macro](https://docs.qmk.fm/#/feature_macros) features | ||
41 | |||
42 | ## Remove `KC_DELT` alias in favor of `KC_DEL` | ||
43 | |||
44 | * `KC_DELT` was a redundant, undocumented alias for `KC_DELETE` | ||
45 | * It has been removed and all its uses replaced with the more common `KC_DEL` alias | ||
46 | * Around 90 keymaps (mostly for ErgoDox boards) have been modified as a result | ||
47 | |||