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

Adding useful commands to documentation #3991

Open
tiif opened this issue Oct 25, 2024 · 2 comments
Open

Adding useful commands to documentation #3991

tiif opened this issue Oct 25, 2024 · 2 comments
Labels
A-docs Area: affects documentation C-enhancement Category: a PR with an enhancement or an issue tracking an accepted enhancement

Comments

@tiif
Copy link
Contributor

tiif commented Oct 25, 2024

I used the commands below when enabling more tests in Tokio. We can consider adding these commands to README as they could be useful to others as well.

  1. To run the entire test suite without terminating on unsupported FFI error, cargo miri nextest run -- no-fail-fast can be used.
  2. If the unsupported FFI errors occur in docs test, adding# if cfg!(miri) { return } will allow Miri to skip the test while still executing it normally with cargo test.
@RalfJung
Copy link
Member

That doesn't really fit in the existing README, it'd be a new section on "how to use Miri on a crate that has many unsupported parts". I think our README will collapse from feature creep if we keep adding stuff like that to it, so IMO this requires us to first transition to a multi-file structure.

@tiif
Copy link
Contributor Author

tiif commented Nov 10, 2024

@rustbot label +A-docs +C-enhancement

@rustbot rustbot added A-docs Area: affects documentation C-enhancement Category: a PR with an enhancement or an issue tracking an accepted enhancement labels Nov 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: affects documentation C-enhancement Category: a PR with an enhancement or an issue tracking an accepted enhancement
Projects
None yet
Development

No branches or pull requests

3 participants