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 | |
| parent | 999391f3ae6bab3fe1784d0f53bffd0320a9e076 (diff) | |
`--parallel` improvements (#13800)
* improve make parallel jobs support
* document the --parallel option
* disable the output-sync for interactive targets
Diffstat (limited to 'docs')
| -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 c7468eb5e7..8fa7ad41dc 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -17,7 +17,7 @@ qmk compile [-c] <configuratorExport.json> **Usage for Keymaps**: ``` -qmk compile [-c] [-e <var>=<value>] -kb <keyboard_name> -km <keymap_name> +qmk compile [-c] [-e <var>=<value>] [-j <num_jobs>] -kb <keyboard_name> -km <keymap_name> ``` **Usage in Keyboard Directory**: @@ -73,6 +73,17 @@ $ qmk compile -kb dz60 ... ``` +**Parallel Compilation**: + +It is possible to speed up compilation by adding the `-j`/`--parallel` flag. +``` +qmk compile -j <num_jobs> -kb <keyboard_name> +``` +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. +``` +qmk compile -j 0 -kb <keyboard_name> +``` + ## `qmk flash` 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 **Usage for Configurator Exports**: ``` -qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] <configuratorExport.json> +qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] <configuratorExport.json> ``` **Usage for Keymaps**: ``` -qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] +qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] ``` **Listing the Bootloaders** |