diff --git a/docs/docs/troubleshooting.md b/docs/docs/troubleshooting.md index a609ce52..9f8e9b28 100644 --- a/docs/docs/troubleshooting.md +++ b/docs/docs/troubleshooting.md @@ -28,7 +28,7 @@ For more information, click [here](../docs/development/setup.md#environment-vari ### West build errors -West build errors usually indicates syntax problems in the `.keymap` file in the compilation process. The following are some examples and root causes. +West build errors usually indicate syntax problems in the `.keymap` file during the compilation process. The following are some examples and root causes. :::note If you are reviewing these errors in the GitHub Actions tab, they can be found in the `West Build` step of the build process. @@ -36,7 +36,7 @@ If you are reviewing these errors in the GitHub Actions tab, they can be found i #### devicetree error -A `devicetree error` followed by a reference to the line number on `.keymap` refers to an issue at the exact line position in that file. For example, below error message indicates a missing `;` at line 109 of the `cradio.keymap` file: +A `devicetree error` followed by a reference to the line number on `.keymap` refers to an issue at the exact line position in that file. For example, below error message indicates a missing `;` at line 109 of the `cradio.keymap` file: ``` devicetree error: /__w/zmk-config/zmk-config/config/cradio.keymap:109 (column 4): parse error: expected ';' or ',' @@ -44,13 +44,13 @@ devicetree error: /__w/zmk-config/zmk-config/config/cradio.keymap:109 (column 4) #### devicetree_unfixed.h error -A `devicetree_unfixed.h` error that follows with an "undeclared here" string indicates a problem with key bindings, like behavior nodes (e.g. `&kp` or `&mt`) with incorrect number of key bindings: +A `devicetree_unfixed.h` error that follows with an "undeclared here" string indicates a problem with key bindings, like behavior nodes (e.g. `&kp` or `&mt`) with incorrect number of parameters: ``` /__w/zmk-config/zmk-config/build/zephyr/include/generated/devicetree_unfixed.h:3756:145: error: 'DT_N_S_keymap_S_symbol_layer_P_bindings_IDX_12_PH_P_label' undeclared here (not in a function); did you mean 'DT_N_S_keymap_S_symbol_layer_P_bindings_IDX_16_PH'? ``` -The error string `DT_N_S_keymap_S_symbol_layer_P_bindings_IDX_12_PH_P_label` indicates a key binding syntax problem on position `12` in the `symbol_layer` of the keymap. +In this example, the error string `DT_N_S_keymap_S_symbol_layer_P_bindings_IDX_12_PH_P_label` indicates a problem with the key binding in position `12` in the `symbol_layer` of the keymap. :::note Key positions are numbered starting from `0` at the top left key on the keymap, incrementing horizontally, row by row.