summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2022-01-25 08:22:20 +1100
committerGitHub <noreply@github.com>2022-01-24 21:22:20 +0000
commit1d11ae3087f583c4f4756169802b33adea71ed94 (patch)
tree6a9deedeecec0220c2dccd10e90941956c4d27b7 /docs
parent3340ca46e82c8b348d9131de53b73e83d1f2c285 (diff)
Rip out old macro and action_function system (#16025)
* Rip out old macro and action_function system * Update quantum/action_util.c Co-authored-by: Joel Challis <git@zvecr.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/config_options.md5
-rw-r--r--docs/feature_haptic_feedback.md3
-rw-r--r--docs/keymap.md2
3 files changed, 1 insertions, 9 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index b661b55ee0..7657fae02e 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -124,10 +124,6 @@ If you define these options you will disable the associated feature, which can s
124 * disable tap dance and other tapping features 124 * disable tap dance and other tapping features
125* `#define NO_ACTION_ONESHOT` 125* `#define NO_ACTION_ONESHOT`
126 * disable one-shot modifiers 126 * disable one-shot modifiers
127* `#define NO_ACTION_MACRO`
128 * disable old-style macro handling using `MACRO()`, `action_get_macro()` _(deprecated)_
129* `#define NO_ACTION_FUNCTION`
130 * disable old-style function handling using `fn_actions`, `action_function()` _(deprecated)_
131 127
132## Features That Can Be Enabled 128## Features That Can Be Enabled
133 129
@@ -383,7 +379,6 @@ This is a [make](https://www.gnu.org/software/make/manual/make.html) file that i
383 * A list of [layouts](feature_layouts.md) this keyboard supports. 379 * A list of [layouts](feature_layouts.md) this keyboard supports.
384* `LTO_ENABLE` 380* `LTO_ENABLE`
385 * Enables Link Time Optimization (LTO) when compiling the keyboard. This makes the process take longer, but it can significantly reduce the compiled size (and since the firmware is small, the added time is not noticeable). 381 * Enables Link Time Optimization (LTO) when compiling the keyboard. This makes the process take longer, but it can significantly reduce the compiled size (and since the firmware is small, the added time is not noticeable).
386However, this will automatically disable the legacy TMK Macros and Functions features, as these break when LTO is enabled. It does this by automatically defining `NO_ACTION_MACRO` and `NO_ACTION_FUNCTION`. (Note: This does not affect QMK [Macros](feature_macros.md) and [Layers](feature_layers.md).)
387 382
388## AVR MCU Options 383## AVR MCU Options
389* `MCU = atmega32u4` 384* `MCU = atmega32u4`
diff --git a/docs/feature_haptic_feedback.md b/docs/feature_haptic_feedback.md
index bbdf7e122c..63ac4305ff 100644
--- a/docs/feature_haptic_feedback.md
+++ b/docs/feature_haptic_feedback.md
@@ -191,9 +191,6 @@ With the entry of `#define NO_HAPTIC_MOD` in config.h, the following keys will n
191* `TT()` layer tap toggle keys, when held to activate a layer. However when tapped `TAPPING_TOGGLE` times to permanently toggle the layer, on the last tap haptic feedback is still triggered. 191* `TT()` layer tap toggle keys, when held to activate a layer. However when tapped `TAPPING_TOGGLE` times to permanently toggle the layer, on the last tap haptic feedback is still triggered.
192* `MT()` mod tap keys, when held to keep a usual modifier key pressed. However when tapped, and the key is quickly released, and sends a keycode, haptic feedback is still triggered. See also [Mod-Tap](mod_tap.md). 192* `MT()` mod tap keys, when held to keep a usual modifier key pressed. However when tapped, and the key is quickly released, and sends a keycode, haptic feedback is still triggered. See also [Mod-Tap](mod_tap.md).
193 193
194### NO_HAPTIC_FN
195With the entry of `#define NO_HAPTIC_FN` in config.h, deprecated `fn_actions` type function keys will not trigger a feedback.
196
197### NO_HAPTIC_ALPHA 194### NO_HAPTIC_ALPHA
198With the entry of `#define NO_HAPTIC_ALPHA` in config.h, none of the alpha keys (A ... Z) will trigger a feedback. 195With the entry of `#define NO_HAPTIC_ALPHA` in config.h, none of the alpha keys (A ... Z) will trigger a feedback.
199 196
diff --git a/docs/keymap.md b/docs/keymap.md
index bec781e684..a7c9c50d74 100644
--- a/docs/keymap.md
+++ b/docs/keymap.md
@@ -136,7 +136,7 @@ After this you'll find a list of LAYOUT() macros. A LAYOUT() is simply a list of
136 136
137`keymaps[][MATRIX_ROWS][MATRIX_COLS]` in QMK holds the 16 bit action code (sometimes referred as the quantum keycode) in it. For the keycode representing typical keys, its high byte is 0 and its low byte is the USB HID usage ID for keyboard. 137`keymaps[][MATRIX_ROWS][MATRIX_COLS]` in QMK holds the 16 bit action code (sometimes referred as the quantum keycode) in it. For the keycode representing typical keys, its high byte is 0 and its low byte is the USB HID usage ID for keyboard.
138 138
139> TMK from which QMK was forked uses `const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS]` instead and holds the 8 bit keycode. Some keycode values are reserved to induce execution of certain action codes via the `fn_actions[]` array. 139> TMK from which QMK was forked uses `const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS]` instead and holds the 8 bit keycode.
140 140
141#### Base Layer 141#### Base Layer
142 142