diff options
author | ruro <ruro.ruro@ya.ru> | 2021-08-18 01:46:59 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-08-18 08:46:59 +1000 |
commit | 3b28178deb7a42a2df8c19b9bf190bb5da732b33 (patch) | |
tree | bbffcc4752948a0f5a52c31930f3ada863e67f44 /docs/cli_commands.md | |
parent | 999391f3ae6bab3fe1784d0f53bffd0320a9e076 (diff) | |
download | qmk_firmware-3b28178deb7a42a2df8c19b9bf190bb5da732b33.tar.gz qmk_firmware-3b28178deb7a42a2df8c19b9bf190bb5da732b33.zip |
`--parallel` improvements (#13800)
* improve make parallel jobs support
* document the --parallel option
* disable the output-sync for interactive targets
Diffstat (limited to 'docs/cli_commands.md')
-rw-r--r-- | docs/cli_commands.md | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index c7468eb5e..8fa7ad41d 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
@@ -17,7 +17,7 @@ qmk compile [-c] <configuratorExport.json> | |||
17 | **Usage for Keymaps**: | 17 | **Usage for Keymaps**: |
18 | 18 | ||
19 | ``` | 19 | ``` |
20 | qmk compile [-c] [-e <var>=<value>] -kb <keyboard_name> -km <keymap_name> | 20 | qmk compile [-c] [-e <var>=<value>] [-j <num_jobs>] -kb <keyboard_name> -km <keymap_name> |
21 | ``` | 21 | ``` |
22 | 22 | ||
23 | **Usage in Keyboard Directory**: | 23 | **Usage in Keyboard Directory**: |
@@ -73,6 +73,17 @@ $ qmk compile -kb dz60 | |||
73 | ... | 73 | ... |
74 | ``` | 74 | ``` |
75 | 75 | ||
76 | **Parallel Compilation**: | ||
77 | |||
78 | It is possible to speed up compilation by adding the `-j`/`--parallel` flag. | ||
79 | ``` | ||
80 | qmk compile -j <num_jobs> -kb <keyboard_name> | ||
81 | ``` | ||
82 | The `num_jobs` argument determines the maximum number of jobs that can be used. Setting it to zero will enable parallel compilation without limiting the maximum number of jobs. | ||
83 | ``` | ||
84 | qmk compile -j 0 -kb <keyboard_name> | ||
85 | ``` | ||
86 | |||
76 | ## `qmk flash` | 87 | ## `qmk flash` |
77 | 88 | ||
78 | This command is similar to `qmk compile`, but can also target a bootloader. The bootloader is optional, and is set to `:flash` by default. To specify a different bootloader, use `-bl <bootloader>`. Visit the [Flashing Firmware](flashing.md) guide for more details of the available bootloaders. | 89 | This command is similar to `qmk compile`, but can also target a bootloader. The bootloader is optional, and is set to `:flash` by default. To specify a different bootloader, use `-bl <bootloader>`. Visit the [Flashing Firmware](flashing.md) guide for more details of the available bootloaders. |
@@ -82,13 +93,13 @@ This command is directory aware. It will automatically fill in KEYBOARD and/or K | |||
82 | **Usage for Configurator Exports**: | 93 | **Usage for Configurator Exports**: |
83 | 94 | ||
84 | ``` | 95 | ``` |
85 | qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] <configuratorExport.json> | 96 | qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] <configuratorExport.json> |
86 | ``` | 97 | ``` |
87 | 98 | ||
88 | **Usage for Keymaps**: | 99 | **Usage for Keymaps**: |
89 | 100 | ||
90 | ``` | 101 | ``` |
91 | qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] | 102 | qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] |
92 | ``` | 103 | ``` |
93 | 104 | ||
94 | **Listing the Bootloaders** | 105 | **Listing the Bootloaders** |