Add --exclude flag #4031

torkleyy · 2017-05-11T18:53:00Z

Allows to exclude packages in conjunction
with --all.

Addresses #2878

rust-highfive · 2017-05-11T18:53:11Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @brson (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

torkleyy

First contribution, would really appreciate if somebody could answer my questions.

torkleyy · 2017-05-11T18:56:33Z

src/bin/build.rs

+    let spec = match (options.flag_all, &options.flag_exclude) {
+        (true, exclude) if exclude.is_empty() => Packages::All,
+        (true, exclude) => Packages::OptOut(exclude),
+        (false, exclude) if !exclude.is_empty() => panic!("--exclude can only be used together \


How would I return a proper error here? More specifically, should I build the CargoError myself or is there some convenience function? Can I use the bail! macro from there?

Yep, bail! is for this use case:

cargo/src/cargo/core/shell.rs

Lines 136 to 145 in 13d92c6

let cfg = match color {

Some("auto") => Auto,

Some("always") => Always,

Some("never") => Never,

None => Auto,

Some(arg) => bail!("argument for --color must be auto, always, or \

never, but found `{}`", arg),

};

torkleyy · 2017-05-11T18:57:16Z

src/bin/build.rs

-        Packages::All
-    } else {
-        Packages::Packages(&options.flag_package)
+    let spec = match (options.flag_all, &options.flag_exclude) {


This match would be used in many subcommands. May I place it in cargo::util?

You could add Packages::from_flags(flag_all, flag_exclude) -> CargoResult<Packeges>.

torkleyy · 2017-05-11T18:59:28Z

src/bin/build.rs

@@ -43,6 +44,7 @@ Options:
    -h, --help                   Print this message
    -p SPEC, --package SPEC ...  Package to build
    --all                        Build all packages in the workspace
+    --exclude SPEC ...           Exclude packages from the build


It seems pretty verbose to manually handle conflicts / requirements of flags. Is there a way to let docopt do this? There is currently sort of a bug when executing cargo build -p whatever --all: The -p is silently ignored.

Is there a way to let docopt do this?

Basically we need to switch to clap, and hopefully get rid of a lot of duplication along the way. But this is a hard task :)

Basically we need to switch to clap

Oh it is desired to switch to clap? It's good to hear that! Is there someone working on it already? If not, I'd love to do it.

Is there someone working on it already?

I've tried to do that, but haven't arrived at something very satisfying :)

It would be super if you would be able to pull this off!

torkleyy · 2017-05-12T15:01:49Z

I'd say this is ready for review.

matklad · 2017-05-15T09:21:20Z

@alexcrichton what do you think about it? I feel that we definitely need something like this, but I am worried that we will have three flags (-pkg, -all, -exclude) to control this behavior.

Hm, maybe we want --pkg foo, --pkg -foo, --pkg *?

torkleyy · 2017-05-15T13:37:35Z

@matklad is "-foo" allowed as argument? If that's the case, I agree that it makes more sense to only have one flag for all of them. Just used --exclude because it was mentionend in that issue.

alexcrichton · 2017-05-15T20:51:10Z

Thanks for the PR @torkleyy! This seems fine to me, @matklad we've got enough flags at this point for "target selection" that it may make sense to basically house their documentation elsewhere at some point. Do you think canonicalizing in one --pkg argument with some syntax is better though? I feel like apart from docs --exclude at least is more self-explanatory than --pkg -foo.

bors · 2017-05-16T01:17:34Z

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

torkleyy · 2017-05-16T09:21:07Z

Rebased

matklad · 2017-05-16T09:23:14Z

I feel like apart from docs --exclude at least is more self-explanatory than --pkg -foo.

Yeah, --exclude is good enough. It's not obvious though what exactly are you excluding:

cargo test --all --exclude baz

Are we excluding baz package or baz module here?

Another option for flag name is --exclude--pkg.

torkleyy · 2017-05-16T09:25:25Z

@matklad I feel excluding a module would be a cheat somehow, so I wouldn't expect it to be possible with cargo. Also you can easily read the description of --exclude. We shouldn't make the flag longer than necessary.

torkleyy · 2017-05-16T09:47:55Z

It seems we got platform-specific behavior here:

I implemented a test which checks for this pattern:

"[..] Compiling bar v0.1.0 ([..])\n\
[..] Compiling foo v0.1.0 ([..])\n

It matches on Linux, however on Windows it seems to compile the crates the other way around.

EDIT: Now it even fails locally, so apparently behavior has changed. Fixing..
Huh? It fails both ways now... What's going on?

matklad · 2017-05-16T10:31:03Z

Huh? It fails both ways now... What's going on?

I bet foo and bar just compile in parallel in arbitrary order. You can use with_stderr_contains and with_stderr_does_not_contain (or you can put broken code in the excluded package and check that it does not break compilation).

Hm, what would happen if you compile foo and exclude bar if foo depends on bar? Should we add this test case?

torkleyy · 2017-05-16T14:44:38Z

exclude bar if foo depends on bar? Should we add this test case?

Oops, thought about this, but completely forgot it!

I'm not sure actually. I think the current behavior is just compiling it if it's a dependency.

matklad · 2017-05-25T11:01:12Z

Let's assign @alexcrichton to this :)

r? @alexcrichton

alexcrichton · 2017-05-26T14:55:37Z

@bors: r+

Looks great to me, thanks again for the PR @torkleyy!

bors · 2017-05-26T14:55:38Z

📌 Commit 9ad240b has been approved by alexcrichton

bors · 2017-05-26T15:55:00Z

⌛ Testing commit 9ad240b with merge 50791b8...

bors · 2017-05-26T17:30:06Z

💔 Test failed - status-travis

torkleyy · 2017-05-26T18:07:48Z

Fixed (it failed because it expected a "filtered out" argument).

alexcrichton · 2017-05-26T21:23:02Z

@bors: r+

bors · 2017-05-26T21:23:03Z

📌 Commit b356af0 has been approved by alexcrichton

bors · 2017-05-26T21:23:10Z

⌛ Testing commit b356af0 with merge 9b856c7...

bors · 2017-05-26T23:00:42Z

💔 Test failed - status-travis

Allows to exclude packages in conjunction with --all.

torkleyy · 2017-05-27T19:02:17Z

Huh? It works for me, even after rebasing onto upstream/master. Anyways, I'll push a fix any moment...

by using with_stderr_contains because parallel build may mix up the lines. Additionally, remove the last line of the benchmark.

alexcrichton · 2017-05-27T23:36:42Z

@bors: r+

Ah yeah I think that's a very recent change on nightly

bors · 2017-05-27T23:36:43Z

📌 Commit dee3c2e has been approved by alexcrichton

bors · 2017-05-27T23:36:50Z

⌛ Testing commit dee3c2e with merge 015897a...

Add --exclude flag Allows to exclude packages in conjunction with --all. Addresses #2878

bors · 2017-05-28T01:02:10Z

☀️ Test successful - status-appveyor, status-travis
Approved by: alexcrichton
Pushing 015897a to master...

@alexcrichton

…hton Support --exclude option for `cargo doc` I think this should have been implemented when the feature was added for other commands. Probably just an oversight. cc #4031 r? @alexcrichton

rust-highfive assigned brson May 11, 2017

torkleyy commented May 11, 2017

View reviewed changes

torkleyy force-pushed the exclude branch 3 times, most recently from fb72d95 to 82cc47e Compare May 12, 2017 14:52

torkleyy changed the title ~~[WIP] Add --exclude flag~~ Add --exclude flag May 12, 2017

torkleyy mentioned this pull request May 13, 2017

Provide a way to run cargo subcommands on all crates in the workspace #2878

Closed

alexcrichton mentioned this pull request May 15, 2017

Allow skipping of specific dependencies in 'cargo doc' #4049

Open

torkleyy force-pushed the exclude branch from 82cc47e to e8a0095 Compare May 16, 2017 09:20

rust-highfive assigned alexcrichton and unassigned brson May 25, 2017

alexcrichton added the relnotes Release-note worthy label May 26, 2017

torkleyy force-pushed the exclude branch from 9ad240b to b356af0 Compare May 26, 2017 18:07

torkleyy added 4 commits May 27, 2017 20:33

Add --exclude flag

1f57e2c

Allows to exclude packages in conjunction with --all.

Move package flag handling into cargo_compile

7ffd1cf

Add exclude flag to bench, check and test

b054483

Add tests for --exclude

b961de2

Fix build_all_exclude

dee3c2e

by using with_stderr_contains because parallel build may mix up the lines. Additionally, remove the last line of the benchmark.

torkleyy force-pushed the exclude branch from b356af0 to dee3c2e Compare May 27, 2017 19:03

bors added a commit that referenced this pull request May 27, 2017

Auto merge of #4031 - torkleyy:exclude, r=alexcrichton

015897a

Add --exclude flag Allows to exclude packages in conjunction with --all. Addresses #2878

bors merged commit dee3c2e into rust-lang:master May 28, 2017

bors mentioned this pull request May 28, 2017

Apply --all if workspace is virtual #4025

Closed

torkleyy deleted the exclude branch May 28, 2017 03:10

tomprince mentioned this pull request Jun 16, 2017

Re-factor argument parsing so that options shared by multiple commands aren't duplicated. #4177

Closed

matklad mentioned this pull request Feb 26, 2018

Support --exclude option for cargo doc #5081

Merged

daviddrysdale mentioned this pull request Aug 19, 2020

Move oak_runtime and oak_loader crates project-oak/oak#1369

Merged

6 tasks

ehuss added this to the 1.19.0 milestone Feb 6, 2022

	let cfg = match color {
	Some("auto") => Auto,
	Some("always") => Always,
	Some("never") => Never,

	None => Auto,

	Some(arg) => bail!("argument for --color must be auto, always, or \
	never, but found `{}`", arg),
	};

Add --exclude flag #4031

Add --exclude flag #4031

Conversation

torkleyy commented May 11, 2017

rust-highfive commented May 11, 2017

torkleyy left a comment

Choose a reason for hiding this comment

torkleyy May 11, 2017 • edited Loading

Choose a reason for hiding this comment

matklad May 12, 2017

Choose a reason for hiding this comment

torkleyy May 11, 2017

Choose a reason for hiding this comment

matklad May 12, 2017

Choose a reason for hiding this comment

torkleyy May 11, 2017

Choose a reason for hiding this comment

matklad May 12, 2017

Choose a reason for hiding this comment

torkleyy May 12, 2017

Choose a reason for hiding this comment

matklad May 12, 2017

Choose a reason for hiding this comment

torkleyy commented May 12, 2017

matklad commented May 15, 2017

torkleyy commented May 15, 2017

alexcrichton commented May 15, 2017

bors commented May 16, 2017

torkleyy commented May 16, 2017

matklad commented May 16, 2017

torkleyy commented May 16, 2017

torkleyy commented May 16, 2017 • edited Loading

matklad commented May 16, 2017 • edited Loading

torkleyy commented May 16, 2017

matklad commented May 25, 2017

alexcrichton commented May 26, 2017

bors commented May 26, 2017

bors commented May 26, 2017

bors commented May 26, 2017

torkleyy commented May 26, 2017

alexcrichton commented May 26, 2017

bors commented May 26, 2017

bors commented May 26, 2017

bors commented May 26, 2017

torkleyy commented May 27, 2017

alexcrichton commented May 27, 2017

bors commented May 27, 2017

bors commented May 27, 2017

bors commented May 28, 2017

torkleyy May 11, 2017 •

edited

Loading

torkleyy commented May 16, 2017 •

edited

Loading

matklad commented May 16, 2017 •

edited

Loading