puck/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity

reword description of the max-jobs setting

Browse source 
- remove prose for the default value, which is shown programmatically
- add note on how this relates to `cores`
- add link to mentioned derivation attribute
This commit is contained in:
Valentin Gagarin 2023-12-02 02:13:11 +01:00
parent 84fe429dfd
commit 5b281ddf50
1 changed files with 12 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
src/libstore/globals.hh
View file

@ -151,13 +151,18 @@ public:
MaxBuildJobsSetting maxBuildJobs{ MaxBuildJobsSetting maxBuildJobs{
this, 1, "max-jobs", this, 1, "max-jobs",
R"( R"(
This option defines the maximum number of jobs that Nix will try to Maximum number of jobs that Nix will try to build locally in parallel.
build in parallel. The default is `1`. The special value `auto`
causes Nix to use the number of CPUs in your system. `0` is useful The special value `auto` causes Nix to use the number of CPUs in your system.
when using remote builders to prevent any local builds (except for Use `0` to disable local builds and directly use the remote machines specified in [`builders`](#conf-builders).
`preferLocalBuild` derivation attribute which executes locally This will not affect derivations that have [`preferLocalBuild = true`](@docroot@/language/advanced-attributes.md#adv-attr-preferLocalBuild), which are always built locally.
regardless). It can be overridden using the `--max-jobs` (`-j`)
command line switch. > **Note**
>
> The number of CPU cores to use for each build job is independently determined by the [`cores`](#conf-cores) setting.
<!-- TODO(@fricklerhandwerk): would be good to have those shorthands for common options as part of the specification -->
The setting can be overridden using the `--max-jobs` (`-j`) command line switch.
)", )",
{"build-max-jobs"}}; {"build-max-jobs"}};