aboutsummaryrefslogtreecommitdiff
path: root/docs/cli_commands.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/cli_commands.md')
-rw-r--r--docs/cli_commands.md25
1 files changed, 18 insertions, 7 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index e30593daa..0a2bd8121 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -314,7 +314,18 @@ qmk clean [-a]
314 314
315# Developer Commands 315# Developer Commands
316 316
317## `qmk cformat` 317## `qmk format-text`
318
319This command formats text files to have proper line endings.
320
321Every text file in the repository needs to have Unix (LF) line ending.
322If you are working on **Windows**, you must ensure that line endings are corrected in order to get your PRs merged.
323
324```
325qmk format-text
326```
327
328## `qmk format-c`
318 329
319This command formats C code using clang-format. 330This command formats C code using clang-format.
320 331
@@ -325,25 +336,25 @@ Run it with `-a` to format all core code, or pass filenames on the command line
325**Usage for specified files**: 336**Usage for specified files**:
326 337
327``` 338```
328qmk cformat [file1] [file2] [...] [fileN] 339qmk format-c [file1] [file2] [...] [fileN]
329``` 340```
330 341
331**Usage for all core files**: 342**Usage for all core files**:
332 343
333``` 344```
334qmk cformat -a 345qmk format-c -a
335``` 346```
336 347
337**Usage for only changed files against origin/master**: 348**Usage for only changed files against origin/master**:
338 349
339``` 350```
340qmk cformat 351qmk format-c
341``` 352```
342 353
343**Usage for only changed files against branch_name**: 354**Usage for only changed files against branch_name**:
344 355
345``` 356```
346qmk cformat -b branch_name 357qmk format-c -b branch_name
347``` 358```
348 359
349## `qmk docs` 360## `qmk docs`
@@ -398,14 +409,14 @@ $ qmk kle2json -f kle.txt -f
398Ψ Wrote out to info.json 409Ψ Wrote out to info.json
399``` 410```
400 411
401## `qmk pyformat` 412## `qmk format-python`
402 413
403This command formats python code in `qmk_firmware`. 414This command formats python code in `qmk_firmware`.
404 415
405**Usage**: 416**Usage**:
406 417
407``` 418```
408qmk pyformat 419qmk format-python
409``` 420```
410 421
411## `qmk pytest` 422## `qmk pytest`