Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bootstrap: allow setting --jobs in config.toml #131838

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions config.example.toml
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,11 @@
# Specify the location of the Android NDK. Used when targeting Android.
#android-ndk = "/path/to/android-ndk-r26d"

# Number of parallel jobs to be used for building and testing. If set to `0` or
# omitted, it will be automatically determined. This is the `-j`/`--jobs` flag
# passed to cargo invocations.
#jobs = 0

# =============================================================================
# General install configuration options
# =============================================================================
Expand Down
6 changes: 5 additions & 1 deletion src/bootstrap/src/core/config/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -891,6 +891,7 @@ define_config! {
metrics: Option<bool> = "metrics",
android_ndk: Option<PathBuf> = "android-ndk",
optimized_compiler_builtins: Option<bool> = "optimized-compiler-builtins",
jobs: Option<u32> = "jobs",
}
}

Expand Down Expand Up @@ -1289,7 +1290,7 @@ impl Config {
config.rustc_error_format = flags.rustc_error_format;
config.json_output = flags.json_output;
config.on_fail = flags.on_fail;
config.jobs = Some(threads_from_config(flags.jobs as u32));

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

config.cmd = flags.cmd;
config.incremental = flags.incremental;
config.dry_run = if flags.dry_run { DryRun::UserSelected } else { DryRun::Disabled };
Expand Down Expand Up @@ -1511,8 +1512,11 @@ impl Config {
metrics: _,
android_ndk,
optimized_compiler_builtins,
jobs,
} = toml.build.unwrap_or_default();

config.jobs = Some(threads_from_config(flags.jobs.unwrap_or(jobs.unwrap_or(0))));

if let Some(file_build) = build {
config.build = TargetSelection::from_user(&file_build);
};
Expand Down
3 changes: 1 addition & 2 deletions src/bootstrap/src/core/config/flags.rs
Original file line number Diff line number Diff line change
Expand Up @@ -110,11 +110,10 @@ pub struct Flags {
short,
long,
value_hint = clap::ValueHint::Other,
default_value_t = std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get),
value_name = "JOBS"
)]
/// number of jobs to run in parallel
pub jobs: usize,
pub jobs: Option<u32>,
// This overrides the deny-warnings configuration option,
// which passes -Dwarnings to the compiler invocations.
#[arg(global = true, long)]
Expand Down
58 changes: 58 additions & 0 deletions src/bootstrap/src/core/config/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -352,3 +352,61 @@ fn parse_rust_std_features_empty() {
fn parse_rust_std_features_invalid() {
parse("rust.std-features = \"backtrace\"");
}

#[test]
fn parse_jobs() {
assert_eq!(parse("build.jobs = 1").jobs, Some(1));
}
jieyouxu marked this conversation as resolved.
Show resolved Hide resolved

#[test]
fn jobs_precedence() {
// `--jobs` should take precedence over using `--set build.jobs`.

let config = Config::parse_inner(
Flags::parse(&[
"check".to_owned(),
"--config=/does/not/exist".to_owned(),
"--jobs=67890".to_owned(),
"--set=build.jobs=12345".to_owned(),
]),
|&_| toml::from_str(""),
);
assert_eq!(config.jobs, Some(67890));

// `--set build.jobs` should take precedence over `config.toml`.
let config = Config::parse_inner(
Flags::parse(&[
"check".to_owned(),
"--config=/does/not/exist".to_owned(),
"--set=build.jobs=12345".to_owned(),
]),
|&_| {
toml::from_str(
r#"
[build]
jobs = 67890
"#,
)
},
);
assert_eq!(config.jobs, Some(12345));

// `--jobs` > `--set build.jobs` > `config.toml`
let config = Config::parse_inner(
Flags::parse(&[
"check".to_owned(),
"--jobs=123".to_owned(),
"--config=/does/not/exist".to_owned(),
"--set=build.jobs=456".to_owned(),
]),
|&_| {
toml::from_str(
r#"
[build]
jobs = 789
"#,
)
},
);
assert_eq!(config.jobs, Some(123));
}
5 changes: 5 additions & 0 deletions src/bootstrap/src/utils/change_tracker.rs
Original file line number Diff line number Diff line change
Expand Up @@ -275,4 +275,9 @@ pub const CONFIG_CHANGE_HISTORY: &[ChangeInfo] = &[
severity: ChangeSeverity::Info,
summary: "New option `./x setup editor` added, replacing `./x setup vscode` and adding support for vim, emacs and helix.",
},
ChangeInfo {
change_id: 131838,
severity: ChangeSeverity::Info,
summary: "Allow setting `--jobs` in config.toml with `build.jobs`.",
},
];
Loading