summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2019-08-22 10:18:52 -0700
committerskullydazed <skullydazed@users.noreply.github.com>2019-08-31 08:50:25 -0700
commit95477749629407e2a9e33c6ccf26ecc8b24ab07a (patch)
tree77749d8b0a0aaa6e7045aa2f12138f005886b463 /docs
parentd076234fd115ca7a3e5c0f9418e2b28b80c7ec20 (diff)
CLI command to format C code
Diffstat (limited to 'docs')
-rw-r--r--docs/cli.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/cli.md b/docs/cli.md
index 1843f42cd1..4b8472b19e 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -36,3 +36,13 @@ qmk compile <configuratorExport.json>
```
qmk compile -kb <keyboard_name> -km <keymap_name>
```
+
+## `qmk cformat`
+
+This command formats C code using clang-format. Run it with no arguments to format all core code, or pass filenames on the command line to run it on specific files.
+
+**Usage**:
+
+```
+qmk cformat [file1] [file2] [...] [fileN]
+```