summaryrefslogtreecommitdiff
path: root/docs/ChangeLog
diff options
context:
space:
mode:
Diffstat (limited to 'docs/ChangeLog')
-rw-r--r--docs/ChangeLog/20190830.md47
-rw-r--r--docs/ChangeLog/20190830/PR4871.md4
-rw-r--r--docs/ChangeLog/20190830/PR5176.md4
-rw-r--r--docs/ChangeLog/20190830/PR5849.md3
-rw-r--r--docs/ChangeLog/20190830/PR6198.md4
-rw-r--r--docs/ChangeLog/20190830/PR6245.md5
-rw-r--r--docs/ChangeLog/20190830/PR6299.md4
-rw-r--r--docs/ChangeLog/20190830/PR6327.md4
8 files changed, 47 insertions, 28 deletions
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 `<keyboard>/config.h` to `<keyboard>/keymaps/<user>/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 `<keyboard>/config.h` to `<keyboard>/keymaps/<user>/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