summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_debounce_algo.md17
1 files changed, 7 insertions, 10 deletions
diff --git a/docs/feature_debounce_algo.md b/docs/feature_debounce_algo.md
index 2c694cdfbd..e4489662e3 100644
--- a/docs/feature_debounce_algo.md
+++ b/docs/feature_debounce_algo.md
@@ -7,18 +7,16 @@ The underlying debounce algorithm is determined by which matrix.c file you are u
The logic for which debounce method called is below. It checks various defines that you have set in rules.mk
```
-ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
- # Do nothing, debouncing is inside matrix.c inside split_common
-else ifeq ($(strip $(DEBOUNCE_ALGO)), manual)
+ifeq ($(strip $(DEBOUNCE_ALGO)), manual)
# Do nothing. do your debouncing in matrix.c
else ifeq ($(strip $(DEBOUNCE_ALGO)), sym_g)
- TMK_COMMON_SRC += $(DEBOUNCE)/debounce_sym_g.c
+ QUANTUM_SRC += $(DEBOUNCE)/debounce_sym_g.c
else ifeq ($(strip $(DEBOUNCE_ALGO)), eager_pk)
- TMK_COMMON_SRC += $(DEBOUNCE)/debounce_eager_pk.c
+ QUANTUM_SRC += $(DEBOUNCE)/debounce_eager_pk.c
else ifeq ($(strip $(CUSTOM_MATRIX)), yes)
# Do nothing. Custom matrix code.
else # default algorithm
- TMK_COMMON_SRC += $(DEBOUNCE)/debounce_sym_g.c
+ QUANTUM_SRC += $(DEBOUNCE)/debounce_sym_g.c
endif
```
@@ -32,11 +30,10 @@ The following is for keyboards where ```SPLIT_KEYBOARD``` is **not** defined as
| sym_g / eager_pk | Not defined | You are using the included matrix.c and debounce.c | Nothing. Chosen debounce method used. |
| Not defined | YES | You have your own matrix.c, and your own debounce | Write the fully debounced matrix into matrix.c's matrix |
| manual | YES | Same as above | same as above |
-| sym_g/ eager_pk | YES | You are using your own matrix.c, but included debounce | Write the raw matrix values into matrix.c's matrix |
+| sym_g / eager_pk | YES | You are using your own matrix.c, but included debounce | Write the raw matrix values into matrix.c's matrix |
-**Note**:
-If ```SPLIT_KEYBOARD = YES``` is defined, the algorithm inside split_common will be used.
-A future pull request will fix this to use the debounce.c code.
+**Regarding split keyboards**:
+The debounce code is compatible with split keyboards.
# Use your own debouncing code
* Set ```DEBOUNCE_ALGO = manual```.