Merge pull request #9521 from fricklerhandwerk/conf-reword-max-jobs

reword description of the `max-jobs` setting
This commit is contained in:
John Ericson 2024-01-22 08:29:12 -05:00 committed by GitHub
commit b2066c3574
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

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"}};