docs: mention that Clippy must be run with the MSRV #4676
Conversation
There was a problem hiding this comment.
thanks for documenting this, this is definitely good to have written down!
i wonder if we want to add a bash script or makefile or something for running clippy with the correct version, eventually?
i suggested adding some other places where we record the MSRV in the lists of places that need to be updated, but besides that, this change looks good to me!
CONTRIBUTING.md
Outdated
| <!-- | ||
| When updating this, also update: | ||
| - .github/workflows/ci.yml | ||
| - README.md | ||
| - tokio/README.md | ||
| --> |
There was a problem hiding this comment.
it would be really nice to have a script for this or something, or some way to to have a single authoritative definition of the MSRV that is referenced elsewhere. there are now several places where the MSRV will need to be updated.
obviously, this would be best left for a separate PR, but i thought it was worth noting.
|
ugh...i forgot that we have a CI job that checks that the two README files are identical, which is now failing because they list different other locations that need to be updated: https://github.com/tokio-rs/tokio/runs/6374617535?check_suite_focus=true we should probably just add each README's own path to the list of updated items so that CI job can pass. |
| Clippy must be run using the MSRV, so Tokio can avoid having to `#[allow]` new | ||
| lints whose fixes would be incompatible with the current MSRV: |
There was a problem hiding this comment.
Note that we are actually using a newer version of clippy than MSRV (it is needed for some regression tests).
tokio/.github/workflows/ci.yml
Line 15 in d8fb721
| # When updating this, also update: | ||
| # - README.md | ||
| # - tokio/README.md | ||
| # - CONTRIBUTING.md | ||
| # - tokio/Cargo.toml | ||
| # - tokio-util/Cargo.toml | ||
| # - tokio-test/Cargo.toml | ||
| # - tokio-stream/Cargo.toml |
There was a problem hiding this comment.
There is also .clippy.toml (it is a way to tell MSRV to clippy).
Line 1 in d8fb721
Motivation
In #4675 I learnt the hard way that Tokio uses Clippy on its MSRV.
Solution
Document this in the contributor's guide.