mirror of
https://github.com/rust-lang/rust-clippy
synced 2024-11-10 15:14:29 +00:00
Mention how to install master Rust in CONTRIBUTING
This commit is contained in:
parent
3fee6d6438
commit
9c50aa8810
1 changed files with 19 additions and 5 deletions
|
@ -19,7 +19,7 @@ All contributors are expected to follow the [Rust Code of Conduct](http://www.ru
|
|||
* [Running test suite](#running-test-suite)
|
||||
* [Testing manually](#testing-manually)
|
||||
* [How Clippy works](#how-clippy-works)
|
||||
* [Fixing nightly build failures](#fixing-nightly-build-failures)
|
||||
* [Fixing nightly build failures](#fixing-build-failures-caused-by-rust)
|
||||
* [Contributions](#contributions)
|
||||
|
||||
## Getting started
|
||||
|
@ -202,16 +202,29 @@ The difference between `EarlyLintPass` and `LateLintPass` is that the methods of
|
|||
|
||||
That's why the `else_if_without_else` example uses the `register_early_lint_pass` function. Because the [actual lint logic][else_if_without_else] does not depend on any type information.
|
||||
|
||||
### Fixing nightly build failures
|
||||
### Fixing build failures caused by Rust
|
||||
|
||||
Clippy will sometimes break with new nightly version releases. This is expected because Clippy still depends on nightly Rust. Most of the times we have to adapt to the changes and only very rarely there's an actual bug in rust.
|
||||
Clippy will sometimes break because Clippy still depends on unstable internal Rust features. Most of the times we have to adapt to the changes and only very rarely there's an actual bug in rust.
|
||||
|
||||
In order to find out why Clippy does not work properly with a new nightly version, you can use the [rust-toolstate commit history][toolstate_commit_history].
|
||||
In order to find out why Clippy does not work properly with a new Rust commit, you can use the [rust-toolstate commit history][toolstate_commit_history].
|
||||
You will then have to look for the last commit that contains `test-pass -> build-fail` or `test-pass` -> `test-fail` for the `clippy-driver` component. [Here][toolstate_commit] is an example.
|
||||
|
||||
The commit message contains a link to the PR. The PRs are usually small enough to discover the breaking API change and if they are bigger, they likely include some discussion that may help you to fix Clippy.
|
||||
|
||||
Fixing nightly build failures is also a good way to learn about actual rustc internals.
|
||||
Fixing build failures caused by rustc changes is also a good way to learn about actual rustc internals.
|
||||
|
||||
If you decide to make Clippy work again with a Rust commit that breaks Clippy,
|
||||
you probably want to install the latest Rust from master locally and run Clippy
|
||||
using that version of Rust.
|
||||
|
||||
You can use [rustup-toolchain-install-master][rtim] to do that:
|
||||
|
||||
```
|
||||
cargo install rustup-toolchain-install-master
|
||||
rustup-toolchain-install-master -n master --force
|
||||
rustup override set master
|
||||
cargo test
|
||||
```
|
||||
|
||||
## Contributions
|
||||
|
||||
|
@ -235,3 +248,4 @@ All code in this repository is under the [Mozilla Public License, 2.0](https://w
|
|||
[late_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/lint/trait.LateLintPass.html
|
||||
[toolstate_commit_history]: https://github.com/rust-lang-nursery/rust-toolstate/commits/master
|
||||
[toolstate_commit]: https://github.com/rust-lang-nursery/rust-toolstate/commit/6ce0459f6bfa7c528ae1886492a3e0b5ef0ee547
|
||||
[rtim]: https://github.com/kennytm/rustup-toolchain-install-master
|
||||
|
|
Loading…
Reference in a new issue