OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

CONTRIBUTING: explain how to use cargo dev ra-setup

Browse Source 
Fixes #5514
This commit is contained in:
Matthias Krüger 2020-05-28 21:42:01 +02:00
parent 9f9877c47f
commit 7727c4ac7f
1 changed files with 28 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
CONTRIBUTING.md
View File

@ -12,14 +12,16 @@ anything, feel free to ask questions on issues or visit the `#clippy` on [Discor
All contributors are expected to follow the [Rust Code of Conduct]. All contributors are expected to follow the [Rust Code of Conduct].
* [Getting started](#getting-started) - [Contributing to Clippy](#contributing-to-clippy)
* [Finding something to fix/improve](#finding-something-to-fiximprove) - [Getting started](#getting-started)
* [Writing code](#writing-code) - [Finding something to fix/improve](#finding-something-to-fiximprove)
* [How Clippy works](#how-clippy-works) - [Writing code](#writing-code)
* [Fixing nightly build failures](#fixing-build-failures-caused-by-rust) - [Getting code-completion for rustc internals to work](#getting-code-completion-for-rustc-internals-to-work)
* [Issue and PR Triage](#issue-and-pr-triage) - [How Clippy works](#how-clippy-works)
* [Bors and Homu](#bors-and-homu) - [Fixing build failures caused by Rust](#fixing-build-failures-caused-by-rust)
* [Contributions](#contributions) - [Issue and PR triage](#issue-and-pr-triage)
- [Bors and Homu](#bors-and-homu)
- [Contributions](#contributions)
[Discord]: https://discord.gg/rust-lang [Discord]: https://discord.gg/rust-lang
[Rust Code of Conduct]: https://www.rust-lang.org/policies/code-of-conduct [Rust Code of Conduct]: https://www.rust-lang.org/policies/code-of-conduct
@ -91,6 +93,24 @@ quick read.
[rfc_stability]: https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#stability-guarantees [rfc_stability]: https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#stability-guarantees
[rfc_lint_cats]: https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#lint-audit-and-categories [rfc_lint_cats]: https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#lint-audit-and-categories
## Getting code-completion for rustc internals to work
Unfortunately, [`rust-analyzer`][ra_homepage] does not (yet?) understand how Clippy uses compiler-internals
using `extern crate` and it also needs to be able to read the source files of the rustc-compiler which are not
available via a `rustup` component at the time of writing.
To work around this, you need to have a copy of the [rustc-repo][rustc_repo] available which can be obtained via
`git clone https://github.com/rust-lang/rust/`.
Then you can run a `cargo dev` command to automatically make Clippy use the rustc-repo via path-dependencies
which rust-analyzer will be able to understand.
Run `cargo dev ra-setup --repo-path <repo-path>` where `<repo-path>` is an absolute path to the rustc repo
you just cloned.
The command will add path-dependencies pointing towards rustc-crates inside the rustc repo to
Clippys `Cargo.toml`s and should allow rust-analyzer to understand most of the types that Clippy uses.
Just make sure to remove the dependencies again before finally making a pull request!
[ra_homepage]: https://rust-analyzer.github.io/
[rustc_repo]: https://github.com/rust-lang/rust/
## How Clippy works ## How Clippy works
[`clippy_lints/src/lib.rs`][lint_crate_entry] imports all the different lint modules and registers in the [`LintStore`]. [`clippy_lints/src/lib.rs`][lint_crate_entry] imports all the different lint modules and registers in the [`LintStore`].