Add option to enable LTO easily (#5674)

[qmk_firmware.git] / docs / config_options.md

diff --git a/docs/config_options.md b/docs/config_options.md
index 8f229a2cb8d169774d0e7400e76e48e2e78893ae..3ef00394dbac8664efe96e33dbe85d0bfa80b2d5 100644 (file)
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -330,6 +330,8 @@ Use these to enable or disable building certain features. The more you have enab
   * Forces the keyboard to wait for a USB connection to be established before it starts up
 * `NO_USB_STARTUP_CHECK`
   * Disables usb suspend check after keyboard startup. Usually the keyboard waits for the host to wake it up before any tasks are performed. This is useful for split keyboards as one half will not get a wakeup call but must send commands to the master.
+* `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 noticable).  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` 
 
 ## USB Endpoint Limitations