Skip to content

Stop recommending cargo clean? #3289

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.

Sign up for GitHub

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

Jump to bottom
Closed
tv42 opened this issue Feb 4, 2024 · 1 comment · Fixed by #3290
Closed

Stop recommending cargo clean? #3289

tv42 opened this issue Feb 4, 2024 · 1 comment · Fixed by #3290

Comments

@tv42
Copy link
Contributor

tv42 commented Feb 4, 2024 •
edited
Loading

The README says

Now you can run your project in Miri:

  1. Run cargo clean to eliminate any cached dependencies. Miri needs your dependencies to be compiled the right way, that would not happen if they have previously already been compiled.

But apparently Miri has used target/miri since 2021 to keep itself separate from non-miri builds:

#1842
6a18683

Would it be safe to simplify the README and save people & computers time by not asking for cargo clean?
@saethlin
Copy link
Member

saethlin commented Feb 4, 2024

Yes. Do you want to send the PR?

@tv42 tv42 mentioned this issue Feb 4, 2024
Merged
bors added a commit that referenced this issue Feb 4, 2024
@bors
Auto merge of #3290 - tv42:master, r=saethlin
f033eb8 
Stop recommending cargo clean in README

Miri has used the `target/miri` subdirectory since 2021 to keep itself separate from non-miri builds, so this should not be necessary.

See commit 6a18683

Since the items are no longer a sequence of steps to do in order ("first, make sure that ..."), switch to an unordered list while we're at it.

Closes #3289
@bors bors closed this as completed in b20f518 Feb 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Stop recommending cargo clean in README tv42/miri
2 participants
@tv42 @saethlin