Skip to content

Commit a777b82

Browse files
charmitrocharmitro
committed
Support "default" option for build.jobs
This commit adds support for passing the keyword "default" to either the CLI "--jobs" argument on the "[build.jobs]" section of ".cargo/config". This is dony by: 1. Changing the "jobs" config type to an enum that holds a String or an Integer(i.e. i32). 2. Matching the enum & casting it to an integer Signed-off-by: Charalampos Mitrodimas <[email protected]>
1 parent 2579f25 commit a777b82

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+189
-46
lines changed

‎src/cargo/core/compiler/build_config.rs

+17-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
use crate::core::compiler::CompileKind;
2+
use crate::util::config::JobsConfig;
23
use crate::util::interning::InternedString;
34
use crate::util::{CargoResult, Config, RustfixDiagnosticServer};
45
use anyhow::{bail, Context as _};
@@ -64,7 +65,7 @@ impl BuildConfig {
6465
/// * `target.$target.libfoo.metadata`
6566
pub fn new(
6667
config: &Config,
67-
jobs: Option<i32>,
68+
jobs: Option<JobsConfig>,
6869
keep_going: bool,
6970
requested_targets: &[String],
7071
mode: CompileMode,
@@ -78,11 +79,22 @@ impl BuildConfig {
7879
its environment, ignoring the `-j` parameter",
7980
)?;
8081
}
81-
let jobs = match jobs.or(cfg.jobs) {
82+
let jobs = match jobs.or(cfg.jobs.clone()) {
8283
None => default_parallelism()?,
83-
Some(0) => anyhow::bail!("jobs may not be 0"),
84-
Some(j) if j < 0 => (default_parallelism()? as i32 + j).max(1) as u32,
85-
Some(j) => j as u32,
84+
Some(value) => match value {
85+
JobsConfig::Integer(j) => match j {
86+
0 => anyhow::bail!("jobs may not be 0"),
87+
j if j < 0 => (default_parallelism()? as i32 + j).max(1) as u32,
88+
j => j as u32,
89+
},
90+
JobsConfig::String(j) => match j.as_str() {
91+
"default" => default_parallelism()?,
92+
_ => {
93+
anyhow::bail!(
94+
format!("could not parse `{j}`. Number of parallel jobs should be `default` or a number."))
95+
}
96+
},
97+
},
8698
};
8799

88100
if config.cli_unstable().build_std.is_some() && requested_kinds[0].is_host() {

‎src/cargo/ops/cargo_fetch.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ use crate::core::compiler::standard_lib;
22
use crate::core::compiler::{BuildConfig, CompileMode, RustcTargetData};
33
use crate::core::{PackageSet, Resolve, Workspace};
44
use crate::ops;
5+
use crate::util::config::JobsConfig;
56
use crate::util::CargoResult;
67
use crate::util::Config;
78
use std::collections::HashSet;
@@ -20,7 +21,7 @@ pub fn fetch<'a>(
2021
ws.emit_warnings()?;
2122
let (mut packages, resolve) = ops::resolve_ws(ws)?;
2223

23-
let jobs = Some(1);
24+
let jobs = Some(JobsConfig::Integer(1));
2425
let keep_going = false;
2526
let config = ws.config();
2627
let build_config = BuildConfig::new(

‎src/cargo/ops/cargo_package.rs

+4-3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ use crate::core::{registry::PackageRegistry, resolver::HasDevUnits};
1313
use crate::core::{Feature, Shell, Verbosity, Workspace};
1414
use crate::core::{Package, PackageId, PackageSet, Resolve, SourceId};
1515
use crate::sources::PathSource;
16+
use crate::util::config::JobsConfig;
1617
use crate::util::errors::CargoResult;
1718
use crate::util::toml::TomlManifest;
1819
use crate::util::{self, human_readable_bytes, restricted_names, Config, FileLock};
@@ -31,7 +32,7 @@ pub struct PackageOpts<'cfg> {
3132
pub check_metadata: bool,
3233
pub allow_dirty: bool,
3334
pub verify: bool,
34-
pub jobs: Option<i32>,
35+
pub jobs: Option<JobsConfig>,
3536
pub keep_going: bool,
3637
pub to_package: ops::Packages,
3738
pub targets: Vec<String>,
@@ -198,7 +199,7 @@ pub fn package(ws: &Workspace<'_>, opts: &PackageOpts<'_>) -> CargoResult<Option
198199
check_metadata: opts.check_metadata,
199200
allow_dirty: opts.allow_dirty,
200201
verify: opts.verify,
201-
jobs: opts.jobs,
202+
jobs: opts.jobs.clone(),
202203
keep_going: opts.keep_going,
203204
to_package: ops::Packages::Default,
204205
targets: opts.targets.clone(),
@@ -861,7 +862,7 @@ fn run_verify(
861862
&ops::CompileOptions {
862863
build_config: BuildConfig::new(
863864
config,
864-
opts.jobs,
865+
opts.jobs.clone(),
865866
opts.keep_going,
866867
&opts.targets,
867868
CompileMode::Build,

‎src/cargo/ops/registry.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ use crate::sources::{RegistrySource, SourceConfigMap, CRATES_IO_DOMAIN, CRATES_I
3232
use crate::util::auth::{
3333
paserk_public_from_paserk_secret, Secret, {self, AuthorizationError},
3434
};
35-
use crate::util::config::{Config, SslVersionConfig, SslVersionConfigRange};
35+
use crate::util::config::{Config, JobsConfig, SslVersionConfig, SslVersionConfigRange};
3636
use crate::util::errors::CargoResult;
3737
use crate::util::important_paths::find_root_manifest_for_wd;
3838
use crate::util::{truncate_with_ellipsis, IntoUrl};
@@ -101,7 +101,7 @@ pub struct PublishOpts<'cfg> {
101101
pub index: Option<String>,
102102
pub verify: bool,
103103
pub allow_dirty: bool,
104-
pub jobs: Option<i32>,
104+
pub jobs: Option<JobsConfig>,
105105
pub keep_going: bool,
106106
pub to_publish: ops::Packages,
107107
pub targets: Vec<String>,
@@ -196,7 +196,7 @@ pub fn publish(ws: &Workspace<'_>, opts: &PublishOpts<'_>) -> CargoResult<()> {
196196
allow_dirty: opts.allow_dirty,
197197
to_package: ops::Packages::Default,
198198
targets: opts.targets.clone(),
199-
jobs: opts.jobs,
199+
jobs: opts.jobs.clone(),
200200
keep_going: opts.keep_going,
201201
cli_features: cli_features,
202202
},

‎src/cargo/util/command_prelude.rs

+13-3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ pub use clap::{value_parser, Arg, ArgAction, ArgMatches};
2323

2424
pub use clap::Command;
2525

26+
use super::config::JobsConfig;
27+
2628
pub trait CommandExt: Sized {
2729
fn _arg(self, arg: Arg) -> Self;
2830

@@ -66,7 +68,7 @@ pub trait CommandExt: Sized {
6668

6769
fn arg_jobs(self) -> Self {
6870
self._arg(
69-
opt("jobs", "Number of parallel jobs, defaults to # of CPUs")
71+
opt("jobs", "Number of parallel jobs, defaults to # of CPUs.")
7072
.short('j')
7173
.value_name("N")
7274
.allow_hyphen_values(true),
@@ -364,8 +366,16 @@ pub trait ArgMatchesExt {
364366
Ok(ws)
365367
}
366368

367-
fn jobs(&self) -> CargoResult<Option<i32>> {
368-
self.value_of_i32("jobs")
369+
fn jobs(&self) -> CargoResult<Option<JobsConfig>> {
370+
let arg = match self._value_of("jobs") {
371+
None => None,
372+
Some(arg) => match arg.parse::<i32>() {
373+
Ok(j) => Some(JobsConfig::Integer(j)),
374+
Err(_) => Some(JobsConfig::String(arg.to_string())),
375+
},
376+
};
377+
378+
Ok(arg)
369379
}
370380

371381
fn verbose(&self) -> u32 {

‎src/cargo/util/config/mod.rs

+20-1
Original file line numberDiff line numberDiff line change
@@ -2449,6 +2449,25 @@ pub struct CargoSshConfig {
24492449
pub known_hosts: Option<Vec<Value<String>>>,
24502450
}
24512451

2452+
/// Configuration for `jobs` in `build` section. There are two
2453+
/// ways to configure: An integer or a simple string expression.
2454+
///
2455+
/// ```toml
2456+
/// [build]
2457+
/// jobs = 1
2458+
/// ```
2459+
///
2460+
/// ```toml
2461+
/// [build]
2462+
/// jobs = "default" # Currently only support "default".
2463+
/// ```
2464+
#[derive(Debug, Deserialize, Clone)]
2465+
#[serde(untagged)]
2466+
pub enum JobsConfig {
2467+
Integer(i32),
2468+
String(String),
2469+
}
2470+
24522471
#[derive(Debug, Deserialize)]
24532472
#[serde(rename_all = "kebab-case")]
24542473
pub struct CargoBuildConfig {
@@ -2458,7 +2477,7 @@ pub struct CargoBuildConfig {
24582477
pub target_dir: Option<ConfigRelativePath>,
24592478
pub incremental: Option<bool>,
24602479
pub target: Option<BuildTargetConfig>,
2461-
pub jobs: Option<i32>,
2480+
pub jobs: Option<JobsConfig>,
24622481
pub rustflags: Option<StringList>,
24632482
pub rustdocflags: Option<StringList>,
24642483
pub rustc_wrapper: Option<ConfigRelativePath>,

‎src/doc/man/generated_txt/cargo-bench.txt

+1
Original file line numberDiff line numberDiff line change
@@ -410,6 +410,7 @@ OPTIONS
410410
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
411411
the number of logical CPUs. If negative, it sets the maximum number
412412
of parallel jobs to the number of logical CPUs plus provided value.
413+
If a string default is provided, it sets the value back to defaults.
413414
Should not be 0.
414415

415416
--keep-going

‎src/doc/man/generated_txt/cargo-build.txt

+1
Original file line numberDiff line numberDiff line change
@@ -341,6 +341,7 @@ OPTIONS
341341
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
342342
the number of logical CPUs. If negative, it sets the maximum number
343343
of parallel jobs to the number of logical CPUs plus provided value.
344+
If a string default is provided, it sets the value back to defaults.
344345
Should not be 0.
345346

346347
--keep-going

‎src/doc/man/generated_txt/cargo-check.txt

+1
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,7 @@ OPTIONS
326326
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
327327
the number of logical CPUs. If negative, it sets the maximum number
328328
of parallel jobs to the number of logical CPUs plus provided value.
329+
If a string default is provided, it sets the value back to defaults.
329330
Should not be 0.
330331

331332
--keep-going

‎src/doc/man/generated_txt/cargo-doc.txt

+1
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,7 @@ OPTIONS
297297
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
298298
the number of logical CPUs. If negative, it sets the maximum number
299299
of parallel jobs to the number of logical CPUs plus provided value.
300+
If a string default is provided, it sets the value back to defaults.
300301
Should not be 0.
301302

302303
--keep-going

‎src/doc/man/generated_txt/cargo-fix.txt

+1
Original file line numberDiff line numberDiff line change
@@ -399,6 +399,7 @@ OPTIONS
399399
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
400400
the number of logical CPUs. If negative, it sets the maximum number
401401
of parallel jobs to the number of logical CPUs plus provided value.
402+
If a string default is provided, it sets the value back to defaults.
402403
Should not be 0.
403404

404405
--keep-going

‎src/doc/man/generated_txt/cargo-install.txt

+1
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,7 @@ OPTIONS
273273
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
274274
the number of logical CPUs. If negative, it sets the maximum number
275275
of parallel jobs to the number of logical CPUs plus provided value.
276+
If a string default is provided, it sets the value back to defaults.
276277
Should not be 0.
277278

278279
--keep-going

‎src/doc/man/generated_txt/cargo-package.txt

+1
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,7 @@ OPTIONS
191191
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
192192
the number of logical CPUs. If negative, it sets the maximum number
193193
of parallel jobs to the number of logical CPUs plus provided value.
194+
If a string default is provided, it sets the value back to defaults.
194195
Should not be 0.
195196

196197
--keep-going

‎src/doc/man/generated_txt/cargo-publish.txt

+1
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,7 @@ OPTIONS
157157
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
158158
the number of logical CPUs. If negative, it sets the maximum number
159159
of parallel jobs to the number of logical CPUs plus provided value.
160+
If a string default is provided, it sets the value back to defaults.
160161
Should not be 0.
161162

162163
--keep-going

‎src/doc/man/generated_txt/cargo-run.txt

+1
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,7 @@ OPTIONS
245245
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
246246
the number of logical CPUs. If negative, it sets the maximum number
247247
of parallel jobs to the number of logical CPUs plus provided value.
248+
If a string default is provided, it sets the value back to defaults.
248249
Should not be 0.
249250

250251
--keep-going

‎src/doc/man/generated_txt/cargo-rustc.txt

+1
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,7 @@ OPTIONS
343343
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
344344
the number of logical CPUs. If negative, it sets the maximum number
345345
of parallel jobs to the number of logical CPUs plus provided value.
346+
If a string default is provided, it sets the value back to defaults.
346347
Should not be 0.
347348

348349
--keep-going

‎src/doc/man/generated_txt/cargo-rustdoc.txt

+1
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,7 @@ OPTIONS
313313
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
314314
the number of logical CPUs. If negative, it sets the maximum number
315315
of parallel jobs to the number of logical CPUs plus provided value.
316+
If a string default is provided, it sets the value back to defaults.
316317
Should not be 0.
317318

318319
--keep-going

‎src/doc/man/generated_txt/cargo-test.txt

+1
Original file line numberDiff line numberDiff line change
@@ -432,6 +432,7 @@ OPTIONS
432432
<https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to
433433
the number of logical CPUs. If negative, it sets the maximum number
434434
of parallel jobs to the number of logical CPUs plus provided value.
435+
If a string default is provided, it sets the value back to defaults.
435436
Should not be 0.
436437

437438
--keep-going

‎src/doc/man/includes/options-jobs.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
Number of parallel jobs to run. May also be specified with the
33
`build.jobs` [config value](../reference/config.html). Defaults to
44
the number of logical CPUs. If negative, it sets the maximum number of
5-
parallel jobs to the number of logical CPUs plus provided value.
5+
parallel jobs to the number of logical CPUs plus provided value. If
6+
a string `default` is provided, it sets the value back to defaults.
67
Should not be 0.
78
{{/option}}

‎src/doc/src/commands/cargo-bench.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,8 @@ Rust test harness runs benchmarks serially in a single thread.
476476
<dd class="option-desc">Number of parallel jobs to run. May also be specified with the
477477
<code>build.jobs</code> <a href="../reference/config.html">config value</a>. Defaults to
478478
the number of logical CPUs. If negative, it sets the maximum number of
479-
parallel jobs to the number of logical CPUs plus provided value.
479+
parallel jobs to the number of logical CPUs plus provided value. If
480+
a string <code>default</code> is provided, it sets the value back to defaults.
480481
Should not be 0.</dd>
481482

482483

‎src/doc/src/commands/cargo-build.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,8 @@ requires the <code>-Z unstable-options</code> flag to enable (see
402402
<dd class="option-desc">Number of parallel jobs to run. May also be specified with the
403403
<code>build.jobs</code> <a href="../reference/config.html">config value</a>. Defaults to
404404
the number of logical CPUs. If negative, it sets the maximum number of
405-
parallel jobs to the number of logical CPUs plus provided value.
405+
parallel jobs to the number of logical CPUs plus provided value. If
406+
a string <code>default</code> is provided, it sets the value back to defaults.
406407
Should not be 0.</dd>
407408

408409

‎src/doc/src/commands/cargo-check.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,8 @@ requires the <code>-Z unstable-options</code> flag to enable (see
383383
<dd class="option-desc">Number of parallel jobs to run. May also be specified with the
384384
<code>build.jobs</code> <a href="../reference/config.html">config value</a>. Defaults to
385385
the number of logical CPUs. If negative, it sets the maximum number of
386-
parallel jobs to the number of logical CPUs plus provided value.
386+
parallel jobs to the number of logical CPUs plus provided value. If
387+
a string <code>default</code> is provided, it sets the value back to defaults.
387388
Should not be 0.</dd>
388389

389390

‎src/doc/src/commands/cargo-doc.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,8 @@ requires the <code>-Z unstable-options</code> flag to enable (see
357357
<dd class="option-desc">Number of parallel jobs to run. May also be specified with the
358358
<code>build.jobs</code> <a href="../reference/config.html">config value</a>. Defaults to
359359
the number of logical CPUs. If negative, it sets the maximum number of
360-
parallel jobs to the number of logical CPUs plus provided value.
360+
parallel jobs to the number of logical CPUs plus provided value. If
361+
a string <code>default</code> is provided, it sets the value back to defaults.
361362
Should not be 0.</dd>
362363

363364

‎src/doc/src/commands/cargo-fix.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,8 @@ requires the <code>-Z unstable-options</code> flag to enable (see
463463
<dd class="option-desc">Number of parallel jobs to run. May also be specified with the
464464
<code>build.jobs</code> <a href="../reference/config.html">config value</a>. Defaults to
465465
the number of logical CPUs. If negative, it sets the maximum number of
466-
parallel jobs to the number of logical CPUs plus provided value.
466+
parallel jobs to the number of logical CPUs plus provided value. If
467+
a string <code>default</code> is provided, it sets the value back to defaults.
467468
Should not be 0.</dd>
468469

469470

‎src/doc/src/commands/cargo-install.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,8 @@ offline.</p>
312312
<dd class="option-desc">Number of parallel jobs to run. May also be specified with the
313313
<code>build.jobs</code> <a href="../reference/config.html">config value</a>. Defaults to
314314
the number of logical CPUs. If negative, it sets the maximum number of
315-
parallel jobs to the number of logical CPUs plus provided value.
315+
parallel jobs to the number of logical CPUs plus provided value. If
316+
a string <code>default</code> is provided, it sets the value back to defaults.
316317
Should not be 0.</dd>
317318

318319

‎src/doc/src/commands/cargo-package.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,8 @@ offline.</p>
227227
<dd class="option-desc">Number of parallel jobs to run. May also be specified with the
228228
<code>build.jobs</code> <a href="../reference/config.html">config value</a>. Defaults to
229229
the number of logical CPUs. If negative, it sets the maximum number of
230-
parallel jobs to the number of logical CPUs plus provided value.
230+
parallel jobs to the number of logical CPUs plus provided value. If
231+
a string <code>default</code> is provided, it sets the value back to defaults.
231232
Should not be 0.</dd>
232233

233234

‎src/doc/src/commands/cargo-publish.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,8 @@ offline.</p>
193193
<dd class="option-desc">Number of parallel jobs to run. May also be specified with the
194194
<code>build.jobs</code> <a href="../reference/config.html">config value</a>. Defaults to
195195
the number of logical CPUs. If negative, it sets the maximum number of
196-
parallel jobs to the number of logical CPUs plus provided value.
196+
parallel jobs to the number of logical CPUs plus provided value. If
197+
a string <code>default</code> is provided, it sets the value back to defaults.
197198
Should not be 0.</dd>
198199

199200

‎src/doc/src/commands/cargo-run.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,8 @@ requires the <code>-Z unstable-options</code> flag to enable (see
299299
<dd class="option-desc">Number of parallel jobs to run. May also be specified with the
300300
<code>build.jobs</code> <a href="../reference/config.html">config value</a>. Defaults to
301301
the number of logical CPUs. If negative, it sets the maximum number of
302-
parallel jobs to the number of logical CPUs plus provided value.
302+
parallel jobs to the number of logical CPUs plus provided value. If
303+
a string <code>default</code> is provided, it sets the value back to defaults.
303304
Should not be 0.</dd>
304305

305306

‎src/doc/src/commands/cargo-rustc.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,8 @@ requires the <code>-Z unstable-options</code> flag to enable (see
396396
<dd class="option-desc">Number of parallel jobs to run. May also be specified with the
397397
<code>build.jobs</code> <a href="../reference/config.html">config value</a>. Defaults to
398398
the number of logical CPUs. If negative, it sets the maximum number of
399-
parallel jobs to the number of logical CPUs plus provided value.
399+
parallel jobs to the number of logical CPUs plus provided value. If
400+
a string <code>default</code> is provided, it sets the value back to defaults.
400401
Should not be 0.</dd>
401402

402403

0 commit comments

Comments
 (0)