aboutsummaryrefslogtreecommitdiff
path: root/docs/cli_commands.md
diff options
context:
space:
mode:
authorJoel Challis <[email protected]>2024-03-05 16:59:30 +0000
committerGitHub <[email protected]>2024-03-05 16:59:30 +0000
commita2c23e9419478cc49d06634732e626a55eec6d66 (patch)
tree352ee29d9adecd14784230948a9f315cfe178fb7 /docs/cli_commands.md
parentbbeb9c1ccd74140dde3bf51adeb3eca70463d22f (diff)
downloadqmk_firmware-a2c23e9419478cc49d06634732e626a55eec6d66.tar.gz
qmk_firmware-a2c23e9419478cc49d06634732e626a55eec6d66.zip
Initial 'qmk test-c' functionality (#23038)
Diffstat (limited to 'docs/cli_commands.md')
-rw-r--r--docs/cli_commands.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index cf174949af..60268122ca 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -791,3 +791,39 @@ This command converts a TTF font to an intermediate format for editing, before c
This command converts an intermediate font image to the QFF File Format. See the [Quantum Painter](quantum_painter.md?id=quantum-painter-cli) documentation for more information on this command.
+## `qmk test-c`
+
+This command runs the C unit test suite. If you make changes to C code you should ensure this runs successfully.
+
+**Usage**:
+
+```
+qmk test-c [-h] [-t TEST] [-l] [-c] [-e ENV] [-j PARALLEL]
+
+options:
+ -h, --help show this help message and exit
+ -t TEST, --test TEST Test to run from the available list. Supports wildcard globs. May be passed multiple times.
+ -l, --list List available tests.
+ -c, --clean Remove object files before compiling.
+ -e ENV, --env ENV Set a variable to be passed to make. May be passed multiple times.
+ -j PARALLEL, --parallel PARALLEL
+ Set the number of parallel make jobs; 0 means unlimited.
+```
+
+**Examples**:
+
+Run entire test suite:
+
+ qmk test-c
+
+List available tests:
+
+ qmk test-c --list
+
+Run matching test:
+
+ qmk test-c --test unicode*
+
+Run single test:
+
+ qmk test-c --test basic