From ac1672689599ff7180b3baaaa9a1356e0e23021e Mon Sep 17 00:00:00 2001 From: fauxpark Date: Wed, 10 Jul 2019 05:34:17 +1000 Subject: LUFA USB descriptor cleanup (#4871) * Fix indentation * Fix braces * Expand descriptor headers * Align descriptor elements * Nicer formatting * Tidy up preprocessor statements * Remove VERSION_BCD redefine - LUFA_VERSION_INTEGER is currently 0x170418 * Tidy up comments * Tweak ordering of HID report elements (no functional changes) * We don't need all of these newlines * Move default USB_MAX_POWER_CONSUMPTION closer to where it makes sense * Ask nicely * Add some more comments * Change indentation back to 4 spaces * Add changelog entry --- docs/ChangeLog/20190830/PR4871.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 docs/ChangeLog/20190830/PR4871.md (limited to 'docs/ChangeLog') diff --git a/docs/ChangeLog/20190830/PR4871.md b/docs/ChangeLog/20190830/PR4871.md new file mode 100644 index 0000000000..e4ea171d7a --- /dev/null +++ b/docs/ChangeLog/20190830/PR4871.md @@ -0,0 +1,4 @@ +* LUFA USB descriptor cleanup + * Some code cleanups related to the USB HID descriptors on AVR keyboards, to make them easier to read and understand + * More information: see https://github.com/qmk/qmk_firmware/pull/4871 + * No behaviour changes anticipated and no keymaps modified -- cgit v1.2.3 From 51ee2449060517a96cedb7c38b86a7de0be2ecab Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Tue, 9 Jul 2019 12:50:53 -0700 Subject: Language Keymap extras backport from ZSA fork (#6198) * Swedish extra keymap refactor * Fix swedish $ sign definition (#81) * Fix br abnt2 keymap compilation error * Add PR changelog doc * Update PR6198.md --- docs/ChangeLog/20190830/PR6198.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 docs/ChangeLog/20190830/PR6198.md (limited to 'docs/ChangeLog') diff --git a/docs/ChangeLog/20190830/PR6198.md b/docs/ChangeLog/20190830/PR6198.md new file mode 100644 index 0000000000..9141ac2507 --- /dev/null +++ b/docs/ChangeLog/20190830/PR6198.md @@ -0,0 +1,4 @@ +* Backport changes to keymap language files from ZSA fork + * Fixes an issue in the `keymap_br_abnt2.h` file that includes the wrong source (`keymap_common.h` instead of `keymap.h`) + * Updates the `keymap_swedish.h` file to be specific to swedish, and not just "nordic" in general. + * Any keymaps using this will need to remove `NO_*` and replace it with `SE_*`. -- cgit v1.2.3 From 554e4bf25c4bcbf263b2e73c6148b7ea1d520762 Mon Sep 17 00:00:00 2001 From: fauxpark Date: Wed, 10 Jul 2019 08:47:35 +1000 Subject: Migrate ACTION_LAYER_MOMENTARYs to MO() (#5176) * Migrate ACTION_LAYER_MOMENTARYs to MO() * Add changelog entry * Update docs/ChangeLog/20190830/PR5176.md Co-Authored-By: skullydazed --- docs/ChangeLog/20190830/PR5176.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 docs/ChangeLog/20190830/PR5176.md (limited to 'docs/ChangeLog') diff --git a/docs/ChangeLog/20190830/PR5176.md b/docs/ChangeLog/20190830/PR5176.md new file mode 100644 index 0000000000..c01b2cb1e3 --- /dev/null +++ b/docs/ChangeLog/20190830/PR5176.md @@ -0,0 +1,4 @@ +* Migrating `ACTION_LAYER_MOMENTARY()` entries in `fn_actions` to `MO()` keycodes + * `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()` + * The end result of removing this obsolete feature should result in a decent reduction in firmware size and code complexity + * 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 -- cgit v1.2.3 From 267a85c885a97219b544a3c706809821c4f28344 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Konstantin=20=C4=90or=C4=91evi=C4=87?= Date: Fri, 2 Aug 2019 21:52:53 +0200 Subject: Remove KC_DELT alias in favor of KC_DEL (#6327) * Remove KC_DELT alias in favor of KC_DEL * Add changelog --- docs/ChangeLog/20190830/PR6327.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 docs/ChangeLog/20190830/PR6327.md (limited to 'docs/ChangeLog') diff --git a/docs/ChangeLog/20190830/PR6327.md b/docs/ChangeLog/20190830/PR6327.md new file mode 100644 index 0000000000..233e10e091 --- /dev/null +++ b/docs/ChangeLog/20190830/PR6327.md @@ -0,0 +1,4 @@ +* Remove `KC_DELT` alias in favor of `KC_DEL` + * `KC_DELT` was a redundant, undocumented alias for `KC_DELETE` + * It has been removed and all its uses replaced with the more common `KC_DEL` alias + * Around 90 keymaps (mostly for ErgoDox boards) have been modified as a result -- cgit v1.2.3 From 3619678b10c772c15dd348dce3d2991e178d7a3d Mon Sep 17 00:00:00 2001 From: fauxpark Date: Sat, 3 Aug 2019 06:12:56 +1000 Subject: Migrate ACTION_BACKLIGHT_* to BL_* (#6299) * Branch point for 2019 Aug 30 Breaking Change * LUFA USB descriptor cleanup (#4871) * Fix indentation * Fix braces * Expand descriptor headers * Align descriptor elements * Nicer formatting * Tidy up preprocessor statements * Remove VERSION_BCD redefine - LUFA_VERSION_INTEGER is currently 0x170418 * Tidy up comments * Tweak ordering of HID report elements (no functional changes) * We don't need all of these newlines * Move default USB_MAX_POWER_CONSUMPTION closer to where it makes sense * Ask nicely * Add some more comments * Change indentation back to 4 spaces * Add changelog entry * Language Keymap extras backport from ZSA fork (#6198) * Swedish extra keymap refactor * Fix swedish $ sign definition (#81) * Fix br abnt2 keymap compilation error * Add PR changelog doc * Update PR6198.md * Enforce clang-format (#6293) * Enforce clang-format on commit for core files * forgot about tests * Migrate ACTION_LAYER_MOMENTARYs to MO() (#5176) * Migrate ACTION_LAYER_MOMENTARYs to MO() * Add changelog entry * Update docs/ChangeLog/20190830/PR5176.md Co-Authored-By: skullydazed * Migrate ACTION_BACKLIGHT_* to BL_* * Add changelog * Update docs/ChangeLog/20190830/PR6299.md Co-Authored-By: skullydazed --- docs/ChangeLog/20190830/PR6299.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 docs/ChangeLog/20190830/PR6299.md (limited to 'docs/ChangeLog') diff --git a/docs/ChangeLog/20190830/PR6299.md b/docs/ChangeLog/20190830/PR6299.md new file mode 100644 index 0000000000..43fb9e031d --- /dev/null +++ b/docs/ChangeLog/20190830/PR6299.md @@ -0,0 +1,4 @@ +* Migrating `ACTION_BACKLIGHT_*()` entries in `fn_actions` to `BL_` keycodes + * `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()` + * All keymaps using these actions have had the relevant `KC_FN*` keys replaced with the equivalent `BL_*` keys + * 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 -- cgit v1.2.3 From 75ee8df19e0f14ba466f41ab673dde2fe2fdae9c Mon Sep 17 00:00:00 2001 From: Joel Challis Date: Fri, 2 Aug 2019 21:35:35 +0100 Subject: Update Atreus to current code conventions (#5849) * Update atreus to current code conventions - add multi revision instead of defines * Remove config.h duplication from user keymaps * Add breaking change log * Add missing pragma once --- docs/ChangeLog/20190830/PR5849.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 docs/ChangeLog/20190830/PR5849.md (limited to 'docs/ChangeLog') diff --git a/docs/ChangeLog/20190830/PR5849.md b/docs/ChangeLog/20190830/PR5849.md new file mode 100644 index 0000000000..24dadc1f27 --- /dev/null +++ b/docs/ChangeLog/20190830/PR5849.md @@ -0,0 +1,3 @@ +* Update Atreus to current code conventions + * Duplicate include guards have bypassed the expected header processing behavior + * All keymaps affected are recommended to remove duplication of `/config.h` to `/keymaps//config.h` and only provide overrides at the keymap level \ No newline at end of file -- cgit v1.2.3 From cf4575b94a3c65e6535a159fc71fc885aebc2620 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Fri, 2 Aug 2019 14:02:40 -0700 Subject: Fix the LUFA lib to use a submodule instead of just files (#6245) * Remove LUFA files * Update descriptions for newer version of LUFA * Create PR6245.md * Fix CDC(Serial) type errors * Fix missed merge conflict for AUDIO_DTYPE_CSInterface --- docs/ChangeLog/20190830/PR6245.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 docs/ChangeLog/20190830/PR6245.md (limited to 'docs/ChangeLog') diff --git a/docs/ChangeLog/20190830/PR6245.md b/docs/ChangeLog/20190830/PR6245.md new file mode 100644 index 0000000000..62e71eee9e --- /dev/null +++ b/docs/ChangeLog/20190830/PR6245.md @@ -0,0 +1,5 @@ +* Update repo to use LUFA as a git submodule + * `/lib/LUFA` removed from the repo + * LUFA set as a submodule, pointing to qmk/lufa + * 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 + -- cgit v1.2.3 From ddb69d4d39ce5e533eb8f64de50e604199a19bfb Mon Sep 17 00:00:00 2001 From: skullY Date: Fri, 30 Aug 2019 12:04:09 -0700 Subject: Merge point for 2019 Aug 30 Breaking Change --- docs/ChangeLog/20190830.md | 47 +++++++++++++++++++++++++++++++++++++++ docs/ChangeLog/20190830/PR4871.md | 4 ---- docs/ChangeLog/20190830/PR5176.md | 4 ---- docs/ChangeLog/20190830/PR5849.md | 3 --- docs/ChangeLog/20190830/PR6198.md | 4 ---- docs/ChangeLog/20190830/PR6245.md | 5 ----- docs/ChangeLog/20190830/PR6299.md | 4 ---- docs/ChangeLog/20190830/PR6327.md | 4 ---- 8 files changed, 47 insertions(+), 28 deletions(-) create mode 100644 docs/ChangeLog/20190830.md delete mode 100644 docs/ChangeLog/20190830/PR4871.md delete mode 100644 docs/ChangeLog/20190830/PR5176.md delete mode 100644 docs/ChangeLog/20190830/PR5849.md delete mode 100644 docs/ChangeLog/20190830/PR6198.md delete mode 100644 docs/ChangeLog/20190830/PR6245.md delete mode 100644 docs/ChangeLog/20190830/PR6299.md delete mode 100644 docs/ChangeLog/20190830/PR6327.md (limited to 'docs/ChangeLog') diff --git a/docs/ChangeLog/20190830.md b/docs/ChangeLog/20190830.md new file mode 100644 index 0000000000..88d7192cbb --- /dev/null +++ b/docs/ChangeLog/20190830.md @@ -0,0 +1,47 @@ +# QMK Breaking Change - 2019 Aug 30 + +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. + +This document marks the inaugural Breaking Change merge. A list of changes follows. + +## LUFA USB descriptor cleanup + +* Some code cleanups related to the USB HID descriptors on AVR keyboards, to make them easier to read and understand +* More information: see https://github.com/qmk/qmk_firmware/pull/4871 +* No behaviour changes anticipated and no keymaps modified + +## Migrating `ACTION_LAYER_MOMENTARY()` entries in `fn_actions` to `MO()` keycodes + +* `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()` +* The end result of removing this obsolete feature should result in a decent reduction in firmware size and code complexity +* 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 + +## Update Atreus to current code conventions + +* Duplicate include guards have bypassed the expected header processing behavior +* All keymaps affected are recommended to remove duplication of `/config.h` to `/keymaps//config.h` and only provide overrides at the keymap level + +## Backport changes to keymap language files from ZSA fork + +* Fixes an issue in the `keymap_br_abnt2.h` file that includes the wrong source (`keymap_common.h` instead of `keymap.h`) +* Updates the `keymap_swedish.h` file to be specific to swedish, and not just "nordic" in general. +* Any keymaps using this will need to remove `NO_*` and replace it with `SE_*`. + +## Update repo to use LUFA as a git submodule + +* `/lib/LUFA` removed from the repo +* LUFA set as a submodule, pointing to qmk/lufa +* 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 + +## Migrating `ACTION_BACKLIGHT_*()` entries in `fn_actions` to `BL_` keycodes + +* `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()` +* All keymaps using these actions have had the relevant `KC_FN*` keys replaced with the equivalent `BL_*` keys +* 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 + +## Remove `KC_DELT` alias in favor of `KC_DEL` + +* `KC_DELT` was a redundant, undocumented alias for `KC_DELETE` +* It has been removed and all its uses replaced with the more common `KC_DEL` alias +* Around 90 keymaps (mostly for ErgoDox boards) have been modified as a result + diff --git a/docs/ChangeLog/20190830/PR4871.md b/docs/ChangeLog/20190830/PR4871.md deleted file mode 100644 index e4ea171d7a..0000000000 --- a/docs/ChangeLog/20190830/PR4871.md +++ /dev/null @@ -1,4 +0,0 @@ -* LUFA USB descriptor cleanup - * Some code cleanups related to the USB HID descriptors on AVR keyboards, to make them easier to read and understand - * More information: see https://github.com/qmk/qmk_firmware/pull/4871 - * No behaviour changes anticipated and no keymaps modified diff --git a/docs/ChangeLog/20190830/PR5176.md b/docs/ChangeLog/20190830/PR5176.md deleted file mode 100644 index c01b2cb1e3..0000000000 --- a/docs/ChangeLog/20190830/PR5176.md +++ /dev/null @@ -1,4 +0,0 @@ -* Migrating `ACTION_LAYER_MOMENTARY()` entries in `fn_actions` to `MO()` keycodes - * `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()` - * The end result of removing this obsolete feature should result in a decent reduction in firmware size and code complexity - * 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 diff --git a/docs/ChangeLog/20190830/PR5849.md b/docs/ChangeLog/20190830/PR5849.md deleted file mode 100644 index 24dadc1f27..0000000000 --- a/docs/ChangeLog/20190830/PR5849.md +++ /dev/null @@ -1,3 +0,0 @@ -* Update Atreus to current code conventions - * Duplicate include guards have bypassed the expected header processing behavior - * All keymaps affected are recommended to remove duplication of `/config.h` to `/keymaps//config.h` and only provide overrides at the keymap level \ No newline at end of file diff --git a/docs/ChangeLog/20190830/PR6198.md b/docs/ChangeLog/20190830/PR6198.md deleted file mode 100644 index 9141ac2507..0000000000 --- a/docs/ChangeLog/20190830/PR6198.md +++ /dev/null @@ -1,4 +0,0 @@ -* Backport changes to keymap language files from ZSA fork - * Fixes an issue in the `keymap_br_abnt2.h` file that includes the wrong source (`keymap_common.h` instead of `keymap.h`) - * Updates the `keymap_swedish.h` file to be specific to swedish, and not just "nordic" in general. - * Any keymaps using this will need to remove `NO_*` and replace it with `SE_*`. diff --git a/docs/ChangeLog/20190830/PR6245.md b/docs/ChangeLog/20190830/PR6245.md deleted file mode 100644 index 62e71eee9e..0000000000 --- a/docs/ChangeLog/20190830/PR6245.md +++ /dev/null @@ -1,5 +0,0 @@ -* Update repo to use LUFA as a git submodule - * `/lib/LUFA` removed from the repo - * LUFA set as a submodule, pointing to qmk/lufa - * 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 - diff --git a/docs/ChangeLog/20190830/PR6299.md b/docs/ChangeLog/20190830/PR6299.md deleted file mode 100644 index 43fb9e031d..0000000000 --- a/docs/ChangeLog/20190830/PR6299.md +++ /dev/null @@ -1,4 +0,0 @@ -* Migrating `ACTION_BACKLIGHT_*()` entries in `fn_actions` to `BL_` keycodes - * `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()` - * All keymaps using these actions have had the relevant `KC_FN*` keys replaced with the equivalent `BL_*` keys - * 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 diff --git a/docs/ChangeLog/20190830/PR6327.md b/docs/ChangeLog/20190830/PR6327.md deleted file mode 100644 index 233e10e091..0000000000 --- a/docs/ChangeLog/20190830/PR6327.md +++ /dev/null @@ -1,4 +0,0 @@ -* Remove `KC_DELT` alias in favor of `KC_DEL` - * `KC_DELT` was a redundant, undocumented alias for `KC_DELETE` - * It has been removed and all its uses replaced with the more common `KC_DEL` alias - * Around 90 keymaps (mostly for ErgoDox boards) have been modified as a result -- cgit v1.2.3 From 1061c024d87609538f5ea10ccf88788067b3e09c Mon Sep 17 00:00:00 2001 From: skullY Date: Fri, 30 Aug 2019 14:26:21 -0700 Subject: Add a note about clang-format to the changelog --- docs/ChangeLog/20190830.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/ChangeLog') diff --git a/docs/ChangeLog/20190830.md b/docs/ChangeLog/20190830.md index 88d7192cbb..d0bddd3c82 100644 --- a/docs/ChangeLog/20190830.md +++ b/docs/ChangeLog/20190830.md @@ -4,6 +4,12 @@ Four times a year QMK runs a process for merging Breaking Changes. A Breaking Ch This document marks the inaugural Breaking Change merge. A list of changes follows. +## Core code formatting with clang-format + +* All core code (`drivers/`, `quantum/`, `tests/`, and `tmk_core`) has been formatted with clang-format +* A travis process to reformat PR's on merge has been instituted +* You can use the new CLI command `qmk cformat` to format before submitting your PR if you wish. + ## LUFA USB descriptor cleanup * Some code cleanups related to the USB HID descriptors on AVR keyboards, to make them easier to read and understand -- cgit v1.2.3 From d21730774752b8bc439564b1e3b687ad2aa0922c Mon Sep 17 00:00:00 2001 From: skullY Date: Fri, 30 Aug 2019 14:27:38 -0700 Subject: consistency --- docs/ChangeLog/20190830.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/ChangeLog') diff --git a/docs/ChangeLog/20190830.md b/docs/ChangeLog/20190830.md index d0bddd3c82..bd2d5e19c3 100644 --- a/docs/ChangeLog/20190830.md +++ b/docs/ChangeLog/20190830.md @@ -6,7 +6,7 @@ This document marks the inaugural Breaking Change merge. A list of changes follo ## Core code formatting with clang-format -* All core code (`drivers/`, `quantum/`, `tests/`, and `tmk_core`) has been formatted with clang-format +* All core files (`drivers/`, `quantum/`, `tests/`, and `tmk_core/`) have been formatted with clang-format * A travis process to reformat PR's on merge has been instituted * You can use the new CLI command `qmk cformat` to format before submitting your PR if you wish. -- cgit v1.2.3