aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/cli_commands.md25
-rw-r--r--docs/cli_development.md4
-rw-r--r--docs/de/cli.md8
-rw-r--r--docs/fr-fr/cli.md8
-rw-r--r--docs/ja/cli_commands.md14
-rw-r--r--docs/ja/cli_development.md4
6 files changed, 37 insertions, 26 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`
diff --git a/docs/cli_development.md b/docs/cli_development.md
index 07c8f281b..0f4f401b3 100644
--- a/docs/cli_development.md
+++ b/docs/cli_development.md
@@ -188,7 +188,7 @@ cli.log.info('Reading from %s and writing to %s', cli.args.filename, cli.args.ou
188 188
189# Testing, and Linting, and Formatting (oh my!) 189# Testing, and Linting, and Formatting (oh my!)
190 190
191We use nose2, flake8, and yapf to test, lint, and format code. You can use the `pytest` and `pyformat` subcommands to run these tests: 191We use nose2, flake8, and yapf to test, lint, and format code. You can use the `pytest` and `format-py` subcommands to run these tests:
192 192
193### Testing and Linting 193### Testing and Linting
194 194
@@ -196,7 +196,7 @@ We use nose2, flake8, and yapf to test, lint, and format code. You can use the `
196 196
197### Formatting 197### Formatting
198 198
199 qmk pyformat 199 qmk format-py
200 200
201## Formatting Details 201## Formatting Details
202 202
diff --git a/docs/de/cli.md b/docs/de/cli.md
index 437062ad6..7dc02d505 100644
--- a/docs/de/cli.md
+++ b/docs/de/cli.md
@@ -88,14 +88,14 @@ qmk compile <configuratorExport.json>
88qmk compile -kb <keyboard_name> -km <keymap_name> 88qmk compile -kb <keyboard_name> -km <keymap_name>
89``` 89```
90 90
91## `qmk cformat` 91## `qmk format-c`
92 92
93Dieser Befehl formatiert C-Code im clang-Format. Benutze ihn ohne Argumente, um den core-Code zu formatieren, oder benutze Namen von Dateien in der CLI, um den Befehl auf bestimmte Dateien anzuwenden. 93Dieser Befehl formatiert C-Code im clang-Format. Benutze ihn ohne Argumente, um den core-Code zu formatieren, oder benutze Namen von Dateien in der CLI, um den Befehl auf bestimmte Dateien anzuwenden.
94 94
95**Anwendung**: 95**Anwendung**:
96 96
97``` 97```
98qmk cformat [file1] [file2] [...] [fileN] 98qmk format-c [file1] [file2] [...] [fileN]
99``` 99```
100 100
101## `qmk config` 101## `qmk config`
@@ -148,14 +148,14 @@ Dieser Befehl erstellt eine neue Keymap basierend auf einer existierenden Standa
148qmk new-keymap [-kb KEYBOARD] [-km KEYMAP] 148qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
149``` 149```
150 150
151## `qmk pyformat` 151## `qmk format-py`
152 152
153Dieser Befehl formatiert Python-Code in `qmk_firmware`. 153Dieser Befehl formatiert Python-Code in `qmk_firmware`.
154 154
155**Anwendung**: 155**Anwendung**:
156 156
157``` 157```
158qmk pyformat 158qmk format-py
159``` 159```
160 160
161## `qmk pytest` 161## `qmk pytest`
diff --git a/docs/fr-fr/cli.md b/docs/fr-fr/cli.md
index 428153645..bfa060f2a 100644
--- a/docs/fr-fr/cli.md
+++ b/docs/fr-fr/cli.md
@@ -85,14 +85,14 @@ qmk compile <configuratorExport.json>
85qmk compile -kb <keyboard_name> -km <keymap_name> 85qmk compile -kb <keyboard_name> -km <keymap_name>
86``` 86```
87 87
88## `qmk cformat` 88## `qmk format-c`
89 89
90Cette commande formatte le code C en utilisant clang-format. Lancez-la sans arguments pour formatter tout le code core, ou passez les noms de fichiers à la ligne de commande pour la lancer sur des fichiers spécifiques. 90Cette commande formatte le code C en utilisant clang-format. Lancez-la sans arguments pour formatter tout le code core, ou passez les noms de fichiers à la ligne de commande pour la lancer sur des fichiers spécifiques.
91 91
92**Utilisation**: 92**Utilisation**:
93 93
94``` 94```
95qmk cformat [file1] [file2] [...] [fileN] 95qmk format-c [file1] [file2] [...] [fileN]
96``` 96```
97 97
98## `qmk config` 98## `qmk config`
@@ -125,14 +125,14 @@ Cette commande crée une nouvelle keymap basée sur une keymap par défaut d'un
125qmk new-keymap [-kb KEYBOARD] [-km KEYMAP] 125qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
126``` 126```
127 127
128## `qmk pyformat` 128## `qmk format-py`
129 129
130Cette commande formate le code python dans `qmk_firmware`. 130Cette commande formate le code python dans `qmk_firmware`.
131 131
132**Utilisation**: 132**Utilisation**:
133 133
134``` 134```
135qmk pyformat 135qmk format-py
136``` 136```
137 137
138## `qmk pytest` 138## `qmk pytest`
diff --git a/docs/ja/cli_commands.md b/docs/ja/cli_commands.md
index 81cb03cfe..35937dbbc 100644
--- a/docs/ja/cli_commands.md
+++ b/docs/ja/cli_commands.md
@@ -211,7 +211,7 @@ qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
211 211
212# 開発者用コマンド 212# 開発者用コマンド
213 213
214## `qmk cformat` 214## `qmk format-c`
215 215
216このコマンドは clang-format を使って C コードを整形します。 216このコマンドは clang-format を使って C コードを整形します。
217 217
@@ -222,25 +222,25 @@ qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
222**指定したファイルに対する使い方**: 222**指定したファイルに対する使い方**:
223 223
224``` 224```
225qmk cformat [file1] [file2] [...] [fileN] 225qmk format-c [file1] [file2] [...] [fileN]
226``` 226```
227 227
228**全てのコアファイルに対する使い方**: 228**全てのコアファイルに対する使い方**:
229 229
230``` 230```
231qmk cformat -a 231qmk format-c -a
232``` 232```
233 233
234**origin/master で変更されたファイルのみに対する使い方**: 234**origin/master で変更されたファイルのみに対する使い方**:
235 235
236``` 236```
237qmk cformat 237qmk format-c
238``` 238```
239 239
240**branch_name で変更されたファイルのみに対する使い方**: 240**branch_name で変更されたファイルのみに対する使い方**:
241 241
242``` 242```
243qmk cformat -b branch_name 243qmk format-c -b branch_name
244``` 244```
245 245
246## `qmk docs` 246## `qmk docs`
@@ -275,14 +275,14 @@ $ qmk kle2json -f kle.txt -f
275Ψ Wrote out to info.json 275Ψ Wrote out to info.json
276``` 276```
277 277
278## `qmk pyformat` 278## `qmk format-py`
279 279
280このコマンドは `qmk_firmware` 内の python コードを整形します。 280このコマンドは `qmk_firmware` 内の python コードを整形します。
281 281
282**使用法**: 282**使用法**:
283 283
284``` 284```
285qmk pyformat 285qmk format-py
286``` 286```
287 287
288## `qmk pytest` 288## `qmk pytest`
diff --git a/docs/ja/cli_development.md b/docs/ja/cli_development.md
index 47262213a..28cdd91c1 100644
--- a/docs/ja/cli_development.md
+++ b/docs/ja/cli_development.md
@@ -192,7 +192,7 @@ cli.log.info('Reading from %s and writing to %s', cli.args.filename, cli.args.ou
192 192
193# テスト、リントおよびフォーマット 193# テスト、リントおよびフォーマット
194 194
195nose2、flake8 および yapf を使ってコードをテスト、リントおよびフォーマットします。これらのテストを実行するために `pytest` と `pyformat` サブコマンドを使うことができます。 195nose2、flake8 および yapf を使ってコードをテスト、リントおよびフォーマットします。これらのテストを実行するために `pytest` と `format-py` サブコマンドを使うことができます。
196 196
197### テストとリント 197### テストとリント
198 198
@@ -200,7 +200,7 @@ nose2、flake8 および yapf を使ってコードをテスト、リントお
200 200
201### フォーマット 201### フォーマット
202 202
203 qmk pyformat 203 qmk format-py
204 204
205## フォーマットの詳細 205## フォーマットの詳細
206 206