20190830.md (3313B)
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 ## Core code formatting with clang-format 8 9 * All core files (`drivers/`, `quantum/`, `tests/`, and `tmk_core/`) have been formatted with clang-format 10 * A travis process to reformat PRs on merge has been instituted 11 * You can use the new CLI command `qmk cformat` to format before submitting your PR if you wish. 12 13 ## LUFA USB descriptor cleanup 14 15 * Some code cleanups related to the USB HID descriptors on AVR keyboards, to make them easier to read and understand 16 * More information: see https://github.com/qmk/qmk_firmware/pull/4871 17 * No behaviour changes anticipated and no keymaps modified 18 19 ## Migrating `ACTION_LAYER_MOMENTARY()` entries in `fn_actions` to `MO()` keycodes 20 21 * `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()` 22 * The end result of removing this obsolete feature should result in a decent reduction in firmware size and code complexity 23 * All keymaps affected are recommended to switch away from `fn_actions` in favour of the [custom keycode](../custom_quantum_functions) and [macro](../feature_macros) features 24 25 ## Update Atreus to current code conventions 26 27 * Duplicate include guards have bypassed the expected header processing behavior 28 * 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 29 30 ## Backport changes to keymap language files from ZSA fork 31 32 * Fixes an issue in the `keymap_br_abnt2.h` file that includes the wrong source (`keymap_common.h` instead of `keymap.h`) 33 * Updates the `keymap_swedish.h` file to be specific to swedish, and not just "nordic" in general. 34 * Any keymaps using this will need to remove `NO_*` and replace it with `SE_*`. 35 36 ## Update repo to use LUFA as a git submodule 37 38 * `/lib/LUFA` removed from the repo 39 * LUFA set as a submodule, pointing to qmk/lufa 40 * 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 41 42 ## Migrating `ACTION_BACKLIGHT_*()` entries in `fn_actions` to `BL_` keycodes 43 44 * `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()` 45 * All keymaps using these actions have had the relevant `KC_FN*` keys replaced with the equivalent `BL_*` keys 46 * If you currently use `KC_FN*` you will need to replace `fn_actions` with the [custom keycode](../custom_quantum_functions) and [macro](../feature_macros) features 47 48 ## Remove `KC_DELT` alias in favor of `KC_DEL` 49 50 * `KC_DELT` was a redundant, undocumented alias for `KC_DELETE` 51 * It has been removed and all its uses replaced with the more common `KC_DEL` alias 52 * Around 90 keymaps (mostly for ErgoDox boards) have been modified as a result