--all-targets ignores specific targets

[mo8it]

Problem

When both --all-targets and a specific target like --bin BIN_NAME are specified, Cargo ignores the specific target. This is not intuitive and not documented.

Steps

1. Create a package with 2 binaries bin1 and bin2.
2. Run cargo check --all-targets --keep-going --bin bin1. (--keep-going to make sure that it runs until the end)
3. Both bin1 and bin2 are checked.

Possible Solution(s)

There are two solutions:

1. My preference: Throw an error because the user is doing something wrong and the result isn't as they would expect.
2. Document that --all-targets ignores any specific targets specified before or after it.

Notes

See related issue in Rust-Analyzer: rust-lang/rust-analyzer#18110

Version

cargo 1.82.0-beta.3 (8f40fc59f 2024-08-21)
release: 1.82.0-beta.3
commit-hash: 8f40fc59fb0c8df91c97405785197f3c630304ea
commit-date: 2024-08-21
host: x86_64-unknown-linux-gnu
libgit2: 1.8.1 (sys:0.19.0 vendored)
libcurl: 8.9.0-DEV (sys:0.4.74+curl-8.9.0 vendored ssl:OpenSSL/1.1.1w)
ssl: OpenSSL 1.1.1w  11 Sep 2023
os: Fedora 40.0.0 [64-bit]

[epage]

Generally, CLI parsers are position-independent. If you say --all-targets --bin NAME or --bin NAME --all-targets, the meaning is the same. In this case, the arguments are additive, so by adding in --all-targets, the --bin flag becomes redundant, not wrong.

The code for where this is handled is at

cargo/src/cargo/ops/cargo_compile/compile_filter.rs

Lines 101 to 128 in 7984efa

	/// Constructs a filter from raw command line arguments.
	pub fn from_raw_arguments(
	lib_only: bool,
	bins: Vec<String>,
	all_bins: bool,
	tsts: Vec<String>,
	all_tsts: bool,
	exms: Vec<String>,
	all_exms: bool,
	bens: Vec<String>,
	all_bens: bool,
	all_targets: bool,
	) -> CompileFilter {
	if all_targets {
	return CompileFilter::new_all_targets();
	}
	let rule_lib = if lib_only {
	LibRule::True
	} else {
	LibRule::False
	};
	let rule_bins = FilterRule::new(bins, all_bins);
	let rule_tsts = FilterRule::new(tsts, all_tsts);
	let rule_exms = FilterRule::new(exms, all_exms);
	let rule_bens = FilterRule::new(bens, all_bens);
	CompileFilter::new(rule_lib, rule_bins, rule_tsts, rule_exms, rule_bens)
	}

This can work well for situations like an alias that you want to override a flag from. I had considered changing clap to prefer the "override" approach over "conflict", in terms of the exact same argument (--all-targets --all-targets). I had decided against this when I realized it can cause stability problems. Cargo changed to allow multiple --target <triple> flags. If we had allowed overriding on it, it would have changed from "override the last" to "append to list" which would have been a behavior change.

That doesn't mean that a conflict in this situation is the most correct approach. Also, if we did change it to an error, we'd need a case to be made for why it is safe and not a breaking change. #13629 does some analysis in that direction. A softer approach could be a warning. We would have to update the CompileFilters to make this decision where we have access to a Shell to send it.

Whether we document or warn for this, it would help to better understand the situation that led to this issue. Why did you combine these arguments? What did you expect from it?

[RalfJung]

Both bin1 and bin2 are checked.

That is what you asked for, so... why do you think this is not intuitive? You said "please build everything" and "please build the bin1 bin target", and cargo did both of these things.

I would find it quite non-intuitive if cargo had not built bin2 in your case.

[mo8it]

Thanks for your input. One could think about explaining this bevahior in the help message, but I don't think that it is required.