diff options
| author | Konstantin Đorđević <vomindoraan@gmail.com> | 2020-04-09 01:18:30 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-09 00:18:30 +0100 |
| commit | be2f5816b6cf6513591f825df1d0438729b83388 (patch) | |
| tree | 86d00fbf766521955ab50706b8d109d800e4b052 /docs/config_options.md | |
| parent | ff213d5fe1a74f345dd2263c6fb4bc9280f74e0f (diff) | |
| download | firmware-be2f5816b6cf6513591f825df1d0438729b83388.tar.gz firmware-be2f5816b6cf6513591f825df1d0438729b83388.tar.bz2 firmware-be2f5816b6cf6513591f825df1d0438729b83388.zip | |
Fix compile issues related to NO_ACTION_MACRO/FUNCTION and LTO_ENABLE (#8663)
* Define NO_ACTION_MACRO/FUNCTION in header instead of makefile when LTO is enabled
Currently, boards and keymaps that define NO_ACTION_MACRO/FUNCTION unconditionally
will not compile with LTO_ENABLE (#8604). This fixes the issue by moving the
definitions from common.mk to action.h, which enables us to check for previous
definitions of those macros (this cannot be done in a makefile).
* Remove LTO checks in templates
Since now NO_ACTION_MACRO/FUNCTION are defined as needed in action.h (which is
included by quantum.h), checking for LTO in keyboard and user code is no
longer required.
* Update LTO_ENABLE docs
Diffstat (limited to 'docs/config_options.md')
| -rw-r--r-- | docs/config_options.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/config_options.md b/docs/config_options.md index 661cfccce..16fea83a3 100644 --- a/docs/config_options.md +++ b/docs/config_options.md @@ -115,9 +115,9 @@ If you define these options you will disable the associated feature, which can s * `#define NO_ACTION_ONESHOT` * disable one-shot modifiers * `#define NO_ACTION_MACRO` - * disable old style macro handling: MACRO() & action_get_macro + * disable old-style macro handling using `MACRO()`, `action_get_macro()` _(deprecated)_ * `#define NO_ACTION_FUNCTION` - * disable calling of action_function() from the fn_actions array (deprecated) + * disable old-style function handling using `fn_actions`, `action_function()` _(deprecated)_ ## Features That Can Be Enabled @@ -317,10 +317,10 @@ This is a [make](https://www.gnu.org/software/make/manual/make.html) file that i * `LAYOUTS` * A list of [layouts](feature_layouts.md) this keyboard supports. * `LINK_TIME_OPTIMIZATION_ENABLE` - * Enables Link Time Optimization (`LTO`) when compiling the keyboard. This makes the process take longer, but can significantly reduce the compiled size (and since the firmware is small, the added time is not noticeable). However, this will automatically disable the old Macros and Functions features automatically, as these break when `LTO` is enabled. - It does this by automatically defining `NO_ACTION_MACRO` and `NO_ACTION_FUNCTION` + * 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). +However, 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).) * `LTO_ENABLE` - * It has the same meaning as LINK_TIME_OPTIMIZATION_ENABLE. You can use `LTO_ENABLE` instead of `LINK_TIME_OPTIMIZATION_ENABLE`. + * Has the same meaning as `LINK_TIME_OPTIMIZATION_ENABLE`. You can use `LTO_ENABLE` instead of `LINK_TIME_OPTIMIZATION_ENABLE`. ## AVR MCU Options * `MCU = atmega32u4` |