summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKonstantin Đorđević <vomindoraan@gmail.com>2019-01-27 09:28:40 +0100
committerDrashna Jaelre <drashna@live.com>2019-01-27 09:28:40 +0100
commit4d9b11af14fd83c1e6b556165d41ce005abb4a84 (patch)
tree99b363853ad21f1d4e6a2ddf0af6f2407c363e96 /docs
parent53d86b2c579b5a5f3488b80f843c274977263ce8 (diff)
downloadqmk_firmware-4d9b11af14fd83c1e6b556165d41ce005abb4a84.tar.gz
qmk_firmware-4d9b11af14fd83c1e6b556165d41ce005abb4a84.tar.xz
Fix Command feature: use get_mods() instead of keyboard_report->mods (#4955)
* Remove unnecessary IS_COMMAND definition in clueboard/66/rev4 * Replace keyboard_report->mods with get_mods() in IS_COMMAND definitions * Update docs to use get_mods() instead of keyboard_report->mods * Replace keyboard_report->mods with get_mods() in tmk_core/protocol/usb_hid/test For some reason, this occurrence used KB_LSHIFT and KB_RSHIFT, which don't exist * Replace keyboard_report->mods with get_mods() in Massdrop keyboards (as per @patrickmt)
Diffstat (limited to 'docs')
-rw-r--r--docs/config_options.md2
-rw-r--r--docs/feature_command.md64
2 files changed, 33 insertions, 33 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index f5c2e76e7..5e2de6d04 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -87,7 +87,7 @@ This is a C header file that is one of the first things included, and will persi
* mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap
* `#define LOCKING_RESYNC_ENABLE`
* tries to keep switch state consistent with keyboard LED state
-* `#define IS_COMMAND() ( keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) )`
+* `#define IS_COMMAND() (get_mods() == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)))`
* key combination that allows the use of magic commands (useful for debugging)
* `#define USB_MAX_POWER_CONSUMPTION`
* sets the maximum power (in mA) over USB for the device (default: 500)
diff --git a/docs/feature_command.md b/docs/feature_command.md
index ca2ecce0d..53a140a11 100644
--- a/docs/feature_command.md
+++ b/docs/feature_command.md
@@ -16,35 +16,35 @@ To use Command, hold down the key combination defined by the `IS_COMMAND()` macr
If you would like to change the key assignments for Command, `#define` these in your `config.h` at either the keyboard or keymap level. All keycode assignments here must omit the `KC_` prefix.
-|Define |Default |Description |
-|------------------------------------|--------------------------------------------------------------------------------------|------------------------------------------------|
-|`IS_COMMAND()` |<code>(keyboard_report->mods == (MOD_BIT(KC_LSHIFT) &#124; MOD_BIT(KC_RSHIFT)))</code>|The key combination to activate Command |
-|`MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS` |`true` |Set default layer with the Function row |
-|`MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS` |`true` |Set default layer with the number keys |
-|`MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM`|`false` |Set default layer with `MAGIC_KEY_LAYER0..9` |
-|`MAGIC_KEY_DEBUG` |`D` |Toggle debugging over serial |
-|`MAGIC_KEY_DEBUG_MATRIX` |`X` |Toggle key matrix debugging |
-|`MAGIC_KEY_DEBUG_KBD` |`K` |Toggle keyboard debugging |
-|`MAGIC_KEY_DEBUG_MOUSE` |`M` |Toggle mouse debugging |
-|`MAGIC_KEY_CONSOLE` |`C` |Enable the Command console |
-|`MAGIC_KEY_VERSION` |`V` |Print the running QMK version to the console |
-|`MAGIC_KEY_STATUS` |`S` |Print the current keyboard status to the console|
-|`MAGIC_KEY_HELP1` |`H` |Print Command help to the console |
-|`MAGIC_KEY_HELP2` |`SLASH` |Print Command help to the console (alternate) |
-|`MAGIC_KEY_LAYER0` |`0` |Make layer 0 the default layer |
-|`MAGIC_KEY_LAYER1` |`1` |Make layer 1 the default layer |
-|`MAGIC_KEY_LAYER2` |`2` |Make layer 2 the default layer |
-|`MAGIC_KEY_LAYER3` |`3` |Make layer 3 the default layer |
-|`MAGIC_KEY_LAYER4` |`4` |Make layer 4 the default layer |
-|`MAGIC_KEY_LAYER5` |`5` |Make layer 5 the default layer |
-|`MAGIC_KEY_LAYER6` |`6` |Make layer 6 the default layer |
-|`MAGIC_KEY_LAYER7` |`7` |Make layer 7 the default layer |
-|`MAGIC_KEY_LAYER8` |`8` |Make layer 8 the default layer |
-|`MAGIC_KEY_LAYER9` |`9` |Make layer 9 the default layer |
-|`MAGIC_KEY_LAYER0_ALT1` |`ESC` |Make layer 0 the default layer (alternate) |
-|`MAGIC_KEY_LAYER0_ALT2` |`GRAVE` |Make layer 0 the default layer (alternate) |
-|`MAGIC_KEY_BOOTLOADER` |`PAUSE` |Enter the bootloader |
-|`MAGIC_KEY_LOCK` |`CAPS` |Lock the keyboard so nothing can be typed |
-|`MAGIC_KEY_EEPROM` |`E` |Clear the EEPROM |
-|`MAGIC_KEY_NKRO` |`N` |Toggle N-Key Rollover (NKRO) |
-|`MAGIC_KEY_SLEEP_LED` |`Z` |Toggle LED when computer is sleeping |
+|Define |Default |Description |
+|------------------------------------|---------------------------------------------------------------------------|------------------------------------------------|
+|`IS_COMMAND()` |<code>(get_mods() == (MOD_BIT(KC_LSHIFT) &#124; MOD_BIT(KC_RSHIFT)))</code>|The key combination to activate Command |
+|`MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS` |`true` |Set default layer with the Function row |
+|`MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS` |`true` |Set default layer with the number keys |
+|`MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM`|`false` |Set default layer with `MAGIC_KEY_LAYER0..9` |
+|`MAGIC_KEY_DEBUG` |`D` |Toggle debugging over serial |
+|`MAGIC_KEY_DEBUG_MATRIX` |`X` |Toggle key matrix debugging |
+|`MAGIC_KEY_DEBUG_KBD` |`K` |Toggle keyboard debugging |
+|`MAGIC_KEY_DEBUG_MOUSE` |`M` |Toggle mouse debugging |
+|`MAGIC_KEY_CONSOLE` |`C` |Enable the Command console |
+|`MAGIC_KEY_VERSION` |`V` |Print the running QMK version to the console |
+|`MAGIC_KEY_STATUS` |`S` |Print the current keyboard status to the console|
+|`MAGIC_KEY_HELP1` |`H` |Print Command help to the console |
+|`MAGIC_KEY_HELP2` |`SLASH` |Print Command help to the console (alternate) |
+|`MAGIC_KEY_LAYER0` |`0` |Make layer 0 the default layer |
+|`MAGIC_KEY_LAYER1` |`1` |Make layer 1 the default layer |
+|`MAGIC_KEY_LAYER2` |`2` |Make layer 2 the default layer |
+|`MAGIC_KEY_LAYER3` |`3` |Make layer 3 the default layer |
+|`MAGIC_KEY_LAYER4` |`4` |Make layer 4 the default layer |
+|`MAGIC_KEY_LAYER5` |`5` |Make layer 5 the default layer |
+|`MAGIC_KEY_LAYER6` |`6` |Make layer 6 the default layer |
+|`MAGIC_KEY_LAYER7` |`7` |Make layer 7 the default layer |
+|`MAGIC_KEY_LAYER8` |`8` |Make layer 8 the default layer |
+|`MAGIC_KEY_LAYER9` |`9` |Make layer 9 the default layer |
+|`MAGIC_KEY_LAYER0_ALT1` |`ESC` |Make layer 0 the default layer (alternate) |
+|`MAGIC_KEY_LAYER0_ALT2` |`GRAVE` |Make layer 0 the default layer (alternate) |
+|`MAGIC_KEY_BOOTLOADER` |`PAUSE` |Enter the bootloader |
+|`MAGIC_KEY_LOCK` |`CAPS` |Lock the keyboard so nothing can be typed |
+|`MAGIC_KEY_EEPROM` |`E` |Clear the EEPROM |
+|`MAGIC_KEY_NKRO` |`N` |Toggle N-Key Rollover (NKRO) |
+|`MAGIC_KEY_SLEEP_LED` |`Z` |Toggle LED when computer is sleeping |