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

Recommend --locked for cargo install #1773

Merged
merged 1 commit into from
Sep 10, 2024

Conversation

samestep
Copy link
Contributor

This PR changes README.md so it recommends users pass the --locked flag to cargo install, which should prevent some surprises. This should also make the behavior more similar to the cargo binstall example command right below.

@pchickey pchickey added this pull request to the merge queue Sep 10, 2024
Merged via the queue into bytecodealliance:main with commit 8b899d9 Sep 10, 2024
30 checks passed
@samestep samestep deleted the cargo-install-locked branch September 10, 2024 16:27
@alexcrichton
Copy link
Member

Thanks for the PR! Out of curiosity was there a concrete breaking thing that happened as a result of missing --locked?

@samestep
Copy link
Contributor Author

@alexcrichton there was not, so this might not actually matter at all; in that case I apologize for the noise!

@alexcrichton
Copy link
Member

Oh no worries! I don't think that this is an unreasonable suggestion, I just personally try to stick to Cargo defaults where possible. I understand though that Cargo's defaults in this regard are somewhat contentious and there's definitely breakage that's possible without --locked. Additionally given the breadth of the full dependency graph with all subcommands enabled it seems like having this is probably a good idea to ensure that breakage never happens in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants