Add Workspace::is_install to detect cargo install
#10966
Conversation
This avoids hardcoding `is_ephemeral && ignore_lock` elsewhere in the codebase.
|
r? @ehuss (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
| @@ -561,6 +561,13 @@ impl<'cfg> Workspace<'cfg> { | |||
| self.member_ids.contains(&pkg.package_id()) | |||
| } | |||
|
|
|||
| /// Returns true if this workspace is being used for a `cargo install` operation | |||
There was a problem hiding this comment.
| /// Returns true if this workspace is being used for a `cargo install` operation | |
| /// Returns true if this workspace is being used for a `cargo install` operation. |
| pub fn is_install(&self) -> bool { | ||
| // For now, this condition detects `cargo install`, but calling `is_install` allows us to | ||
| // more easily change that in the future. | ||
| self.is_ephemeral && self.ignore_lock |
There was a problem hiding this comment.
cargo install --locked is still an install but wouldn't this function return false?
There was a problem hiding this comment.
Oh, good point. I did this based on inspiration from #10891 (comment) . @ehuss, is there a variant of this that would make that code clearer, or should I just drop this change?
There was a problem hiding this comment.
I don't think there is a good way to detect if it is an install. Historically we have tried to avoid making that kind of information available since it is an abstraction loss (the lower-level build code shouldn't know about higher-level concepts like "install").
I think it might be ok to add something to BuildConfig to indicate which command initiated a build. The risk is that it will be abused for changing behavior based on the command. Perhaps if there is a stern comment emphasizing it should only be used for diagnostics would help?
I wouldn't make this a property of the workspace. I forgot to also say that is_ephemeral is only true when installing something from a registry (not a local or git install).
This avoids hardcoding
is_ephemeral && ignore_lockelsewhere in thecodebase.