summaryrefslogtreecommitdiff
path: root/docs/ChangeLog
diff options
context:
space:
mode:
authorFrançois Magimel <magimel.francois@gmail.com>2025-09-09 23:51:13 +0200
committerGitHub <noreply@github.com>2025-09-09 14:51:13 -0700
commit09ab67c0440d8e5e3faf832d23eb1b754845a573 (patch)
tree0edccafc937149afdc8b964004f61fe80942cfa2 /docs/ChangeLog
parent7be4540b4688eab74920eb4cb2347af43fb6a779 (diff)
docs: fix misspellings (#25555)
* docs: fix misspellings * docs: do line breaks with HTML instead of spaces To remove trailing spaces and to avoid breaking things, line breaks can be done with the HTML br tag.
Diffstat (limited to 'docs/ChangeLog')
-rw-r--r--docs/ChangeLog/20200229.md2
-rw-r--r--docs/ChangeLog/20200530.md20
-rw-r--r--docs/ChangeLog/20210529.md6
-rw-r--r--docs/ChangeLog/20210828.md2
-rw-r--r--docs/ChangeLog/20220226.md2
5 files changed, 17 insertions, 15 deletions
diff --git a/docs/ChangeLog/20200229.md b/docs/ChangeLog/20200229.md
index 02bca3e371..fd075c24e0 100644
--- a/docs/ChangeLog/20200229.md
+++ b/docs/ChangeLog/20200229.md
@@ -36,7 +36,7 @@ Four times a year QMK runs a process for merging Breaking Changes. A Breaking Ch
36## Encoder flip 36## Encoder flip
37 37
38* Flips the encoder direction so that `clockwise == true` is for actually turning the knob clockwise 38* Flips the encoder direction so that `clockwise == true` is for actually turning the knob clockwise
39* Adds `ENCODER_DIRECTION_FLIP` define, so that reversing the expected dirction is simple for users. 39* Adds `ENCODER_DIRECTION_FLIP` define, so that reversing the expected direction is simple for users.
40* Cleans up documentation page for encoders 40* Cleans up documentation page for encoders
41 41
42 42
diff --git a/docs/ChangeLog/20200530.md b/docs/ChangeLog/20200530.md
index 9def9ae123..701b6bd5d6 100644
--- a/docs/ChangeLog/20200530.md
+++ b/docs/ChangeLog/20200530.md
@@ -19,7 +19,7 @@ These PRs move the V-USB driver code out of the qmk_firmware repository and into
19 19
20Updates all of the per key tap-hold functions to pass the `keyrecord_t` structure, and include documentation changes. 20Updates all of the per key tap-hold functions to pass the `keyrecord_t` structure, and include documentation changes.
21 21
22Any remaining versions or code outside of the main repo will need to be converted: 22Any remaining versions or code outside of the main repo will need to be converted:
23| Old function | New Function | 23| Old function | New Function |
24|------------------------------------------------------|---------------------------------------------------------------------------| 24|------------------------------------------------------|---------------------------------------------------------------------------|
25|`uint16_t get_tapping_term(uint16_t keycode)` |`uint16_t get_tapping_term(uint16_t keycode, keyrecord_t *record)` | 25|`uint16_t get_tapping_term(uint16_t keycode)` |`uint16_t get_tapping_term(uint16_t keycode, keyrecord_t *record)` |
@@ -38,7 +38,7 @@ After the next breaking change you will not be able to build if `bin/qmk hello`
38[#8269](https://github.com/qmk/qmk_firmware/pull/8269) 38[#8269](https://github.com/qmk/qmk_firmware/pull/8269)
39 39
40- Provides debug functionality on ChibiOS/ARM that is more compliant than previous integrations. 40- Provides debug functionality on ChibiOS/ARM that is more compliant than previous integrations.
41- Less maintenence, fewer QMK customisations, and allows QMK to sidestep previous compile and runtime issues. 41- Less maintenance, fewer QMK customisations, and allows QMK to sidestep previous compile and runtime issues.
42- A `make git-submodule` may be required after pulling the latest QMK Firmware code to update to the new dependency. 42- A `make git-submodule` may be required after pulling the latest QMK Firmware code to update to the new dependency.
43 43
44### Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup 44### Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup
@@ -51,8 +51,10 @@ After the next breaking change you will not be able to build if `bin/qmk hello`
51 51
52The `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. 52The `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.
53 53
54Before: `#define RGB_DISABLE_AFTER_TIMEOUT 100` 54```diff
55After: `#define RGB_DISABLE_TIMEOUT 120000` 55-#define RGB_DISABLE_AFTER_TIMEOUT 100
56+#define RGB_DISABLE_TIMEOUT 120000
57```
56 58
57### Switch to qmk forks for everything 59### Switch to qmk forks for everything
58 60
@@ -103,8 +105,8 @@ This allows current lily58 firmware to advance with updates to the `split_common
103- 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)) 105- 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))
104- [Remove](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7L138-L141) the block 106- [Remove](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7L138-L141) the block
105```c 107```c
106#ifdef SSD1306OLED 108#ifdef SSD1306OLED
107 iota_gfx_init(!has_usb()); // turns on the display 109 iota_gfx_init(!has_usb()); // turns on the display
108#endif 110#endif
109``` 111```
110- 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: 112- 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:
@@ -127,7 +129,7 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) {
127 129
128* Refactor to use split_common and remove split codes under the zinc/revx/ 130* Refactor to use split_common and remove split codes under the zinc/revx/
129* Add - backlight RGB LED and/or underglow RGB LED option 131* Add - backlight RGB LED and/or underglow RGB LED option
130* Add - continuous RGB animations feature (between L and R halves) 132* Add - continuous RGB animations feature (between L and R halves)
131* Fix - keymap files to adapt to changes 133* Fix - keymap files to adapt to changes
132 * all authors of keymaps confirmed this PR 134 * all authors of keymaps confirmed this PR
133* Update - documents and rules.mk 135* Update - documents and rules.mk
@@ -164,8 +166,8 @@ void keyboard_pre_init_kb(void) {
164- 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) 166- 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)
165- [Remove](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7L91-L158) the block 167- [Remove](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7L91-L158) the block
166```c 168```c
167#ifdef SSD1306OLED 169#ifdef SSD1306OLED
168 iota_gfx_init(!has_usb()); // turns on the display 170 iota_gfx_init(!has_usb()); // turns on the display
169#endif 171#endif
170``` 172```
171- 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: 173- 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:
diff --git a/docs/ChangeLog/20210529.md b/docs/ChangeLog/20210529.md
index 69923b0c5a..e3d250874a 100644
--- a/docs/ChangeLog/20210529.md
+++ b/docs/ChangeLog/20210529.md
@@ -12,7 +12,7 @@ Added support for MK66F18 (Teensy 3.6) microcontroller.
12 12
13### New command: qmk console ([#12828](https://github.com/qmk/qmk_firmware/pull/12828)) {#new-command-qmk-console} 13### New command: qmk console ([#12828](https://github.com/qmk/qmk_firmware/pull/12828)) {#new-command-qmk-console}
14 14
15A new `qmk console` command has been added for attaching to your keyboard's console. It operates similiarly to QMK Toolbox by allowing you to connect to one or more keyboard consoles to display debugging messages. 15A new `qmk console` command has been added for attaching to your keyboard's console. It operates similarly to QMK Toolbox by allowing you to connect to one or more keyboard consoles to display debugging messages.
16 16
17### Improved command: qmk config {#improve-command-qmk-config} 17### Improved command: qmk config {#improve-command-qmk-config}
18 18
@@ -121,8 +121,8 @@ bool encoder_update_user(uint8_t index, bool clockwise) {
121 tap_code(KC_UP); 121 tap_code(KC_UP);
122 } 122 }
123 } 123 }
124 return true; 124 return true;
125 // If you return true, this will allow the keyboard level code to run, as well. 125 // If you return true, this will allow the keyboard level code to run, as well.
126 //Returning false will override the keyboard level code. Depending on how the keyboard level function is set up. 126 //Returning false will override the keyboard level code. Depending on how the keyboard level function is set up.
127} 127}
128``` 128```
diff --git a/docs/ChangeLog/20210828.md b/docs/ChangeLog/20210828.md
index 18b1d92b0c..9268711262 100644
--- a/docs/ChangeLog/20210828.md
+++ b/docs/ChangeLog/20210828.md
@@ -104,7 +104,7 @@ void dip_switch_update_user(uint8_t index, bool active) {
104 } 104 }
105} 105}
106 106
107void dip_switch_update_mask_kb(uint32_t state) { 107void dip_switch_update_mask_kb(uint32_t state) {
108 dip_switch_update_mask_user(state); 108 dip_switch_update_mask_user(state);
109} 109}
110 110
diff --git a/docs/ChangeLog/20220226.md b/docs/ChangeLog/20220226.md
index a10b6447ea..29283a3a9c 100644
--- a/docs/ChangeLog/20220226.md
+++ b/docs/ChangeLog/20220226.md
@@ -29,7 +29,7 @@ Bootloader configuration is no longer assumed. Keyboards must now set either:
29 29
30### Rename `AdafruitBLE` to `BluefruitLE` ([#16127](https://github.com/qmk/qmk_firmware/pull/16127)) 30### Rename `AdafruitBLE` to `BluefruitLE` ([#16127](https://github.com/qmk/qmk_firmware/pull/16127))
31 31
32In preparation of future bluetooth work, the `AdafruitBLE` integration has been renamed to allow potential for any other Adafruit BLE products. 32In preparation of future bluetooth work, the `AdafruitBLE` integration has been renamed to allow potential for any other Adafruit BLE products.
33 33
34### Updated Keyboard Codebases {#updated-keyboard-codebases} 34### Updated Keyboard Codebases {#updated-keyboard-codebases}
35 35