Document interaction between custom profiles and overrides #13590

vlovich · 2024-03-15T16:19:07Z

Not sure if I actually captured the behavior correctly.

What does this PR try to resolve?

Do custom profiles keep package overrides requiring the exact same set to be duplicated if a setting needs to be changed, or are the overrides discarded for a custom profile & the overrides need to be repeated if any settings need to be persisted?

How should we test and review this PR?

N/A - just need to document current behavior.

Additional information

N/A

Not sure if I actually captured the behavior correctly. Do custom profiles keep package overrides requiring the exact same set to be duplicated if a setting needs to be changed, or are the overrides discarded for a custom profile & the overrides need to be repeated if any settings need to be persisted?

rustbot · 2024-03-15T16:19:12Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @epage (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

@rustbot author: the review is finished, PR author should check the comments and take action accordingly
@rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

vlovich · 2024-03-15T16:35:23Z

@rustbot review

ehuss · 2024-03-15T16:38:39Z

Overrides should be inherited. If you are having problems with the inheritance, I'd recommend opening an issue with a reproduction showing what doesn't seem to be working.

vlovich · 2024-03-15T16:45:27Z

@ehuss fixed the wording to reflect the correct state.

weihanglo · 2024-03-24T04:03:55Z

src/doc/src/reference/profiles.md

+NOTE: Custom profiles inherit package overrides as well and those take precedence
+over the default custom profile settings. See the [overrides](#overrides) section for more.


What do you think about adding a sentence at line 250, instead of this?

- setting is not specified. + setting is not specified. Note that a custom profile inherits everything from + the other profile, including package and build [overrides](#overrides).

weihanglo · 2024-03-24T04:34:32Z

src/doc/src/reference/profiles.md

@@ -457,6 +460,26 @@ match wins):

 Overrides cannot specify the `panic`, `lto`, or `rpath` settings.

+Overrides inherit to custom profiles and take precedence unless explicitly overriden.
+For example, in the below example package `foo` will still be built with `opt-level = 1`


This doesn't seem to match the current behavior. Check this test as a reference:

cargo/tests/testsuite/profile_custom.rs

Lines 295 to 364 in 61855e7

fn overrides_with_custom() {

let p = project()

.file(

"Cargo.toml",

r#"

[package]

name = "foo"

version = "0.0.1"

edition = "2015"

authors = []

[dependencies]

xxx = {path = "xxx"}

yyy = {path = "yyy"}

[profile.dev]

codegen-units = 7

[profile.dev.package.xxx]

codegen-units = 5

[profile.dev.package.yyy]

codegen-units = 3

[profile.other]

inherits = "dev"

codegen-units = 2

[profile.other.package.yyy]

codegen-units = 6

"#,

)

.file("src/lib.rs", "")

.file("xxx/Cargo.toml", &basic_lib_manifest("xxx"))

.file("xxx/src/lib.rs", "")

.file("yyy/Cargo.toml", &basic_lib_manifest("yyy"))

.file("yyy/src/lib.rs", "")

.build();

// profile overrides are inherited between profiles using inherits and have a

// higher priority than profile options provided by custom profiles

p.cargo("build -v")

.with_stderr_unordered(

"\

[LOCKING] 3 packages

[COMPILING] xxx [..]

[COMPILING] yyy [..]

[COMPILING] foo [..]

[RUNNING] `rustc --crate-name xxx [..] -C codegen-units=5 [..]`

[RUNNING] `rustc --crate-name yyy [..] -C codegen-units=3 [..]`

[RUNNING] `rustc --crate-name foo [..] -C codegen-units=7 [..]`

[FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [..]

",

)

.run();

// This also verifies that the custom profile names appears in the finished line.

p.cargo("build --profile=other -v")

.with_stderr_unordered(

"\

[COMPILING] xxx [..]

[COMPILING] yyy [..]

[COMPILING] foo [..]

[RUNNING] `rustc --crate-name xxx [..] -C codegen-units=5 [..]`

[RUNNING] `rustc --crate-name yyy [..] -C codegen-units=6 [..]`

[RUNNING] `rustc --crate-name foo [..] -C codegen-units=2 [..]`

[FINISHED] `other` profile [unoptimized + debuginfo] target(s) in [..]

",

)

.run();

}

weihanglo · 2024-03-24T04:36:56Z

@rustbot author

weihanglo · 2024-06-17T14:25:26Z

@vlovich are you still interested in moving this forward?

bors · 2024-10-03T20:43:10Z

☔ The latest upstream changes (presumably #14620) made this pull request unmergeable. Please resolve the merge conflicts.

weihanglo · 2024-10-04T02:03:37Z

I'm going to close due to inactivity. There were some imprecise understanding in the patch. If you have a chance to help and improve it, feel free to reopen a pull request.

rustbot assigned epage Mar 15, 2024

rustbot added A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 15, 2024

vlovich marked this pull request as ready for review March 15, 2024 16:35

Fix wording

c003ad0

vlovich added 2 commits March 15, 2024 09:56

Clear up wording some more

ba0dd83

More wording cleanup.

46e1b83

weihanglo reviewed Mar 24, 2024

View reviewed changes

rustbot added S-waiting-on-author Status: The marked PR is awaiting some action (such as code changes) from the PR author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 24, 2024

weihanglo closed this Oct 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document interaction between custom profiles and overrides #13590

Document interaction between custom profiles and overrides #13590

vlovich commented Mar 15, 2024

rustbot commented Mar 15, 2024

vlovich commented Mar 15, 2024

ehuss commented Mar 15, 2024

vlovich commented Mar 15, 2024

weihanglo Mar 24, 2024

weihanglo Mar 24, 2024

weihanglo commented Mar 24, 2024

weihanglo commented Jun 17, 2024

bors commented Oct 3, 2024

weihanglo commented Oct 4, 2024

		NOTE: Custom profiles inherit package overrides as well and those take precedence
		over the default custom profile settings. See the [overrides](#overrides) section for more.

	fn overrides_with_custom() {
	let p = project()
	.file(
	"Cargo.toml",
	r#"
	[package]
	name = "foo"
	version = "0.0.1"
	edition = "2015"
	authors = []

	[dependencies]
	xxx = {path = "xxx"}
	yyy = {path = "yyy"}

	[profile.dev]
	codegen-units = 7

	[profile.dev.package.xxx]
	codegen-units = 5
	[profile.dev.package.yyy]
	codegen-units = 3

	[profile.other]
	inherits = "dev"
	codegen-units = 2

	[profile.other.package.yyy]
	codegen-units = 6
	"#,
	)
	.file("src/lib.rs", "")
	.file("xxx/Cargo.toml", &basic_lib_manifest("xxx"))
	.file("xxx/src/lib.rs", "")
	.file("yyy/Cargo.toml", &basic_lib_manifest("yyy"))
	.file("yyy/src/lib.rs", "")
	.build();

	// profile overrides are inherited between profiles using inherits and have a
	// higher priority than profile options provided by custom profiles
	p.cargo("build -v")
	.with_stderr_unordered(
	"\
	[LOCKING] 3 packages
	[COMPILING] xxx [..]
	[COMPILING] yyy [..]
	[COMPILING] foo [..]
	[RUNNING] `rustc --crate-name xxx [..] -C codegen-units=5 [..]`
	[RUNNING] `rustc --crate-name yyy [..] -C codegen-units=3 [..]`
	[RUNNING] `rustc --crate-name foo [..] -C codegen-units=7 [..]`
	[FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [..]
	",
	)
	.run();

	// This also verifies that the custom profile names appears in the finished line.
	p.cargo("build --profile=other -v")
	.with_stderr_unordered(
	"\
	[COMPILING] xxx [..]
	[COMPILING] yyy [..]
	[COMPILING] foo [..]
	[RUNNING] `rustc --crate-name xxx [..] -C codegen-units=5 [..]`
	[RUNNING] `rustc --crate-name yyy [..] -C codegen-units=6 [..]`
	[RUNNING] `rustc --crate-name foo [..] -C codegen-units=2 [..]`
	[FINISHED] `other` profile [unoptimized + debuginfo] target(s) in [..]
	",
	)
	.run();
	}

Document interaction between custom profiles and overrides #13590

Document interaction between custom profiles and overrides #13590

Conversation

vlovich commented Mar 15, 2024

What does this PR try to resolve?

How should we test and review this PR?

Additional information

rustbot commented Mar 15, 2024

vlovich commented Mar 15, 2024

ehuss commented Mar 15, 2024

vlovich commented Mar 15, 2024

weihanglo Mar 24, 2024

Choose a reason for hiding this comment

weihanglo Mar 24, 2024

Choose a reason for hiding this comment

weihanglo commented Mar 24, 2024

weihanglo commented Jun 17, 2024

bors commented Oct 3, 2024

weihanglo commented Oct 4, 2024