From 2561a3decc75e50006e16ebefef9002f441d6b77 Mon Sep 17 00:00:00 2001 From: Hirokazu Hata Date: Sun, 27 Jan 2019 19:41:20 +0900 Subject: [PATCH] Add how RLS can be built without clippy_lints --- contributing.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/contributing.md b/contributing.md index 51f9ecf8f1e..3dd6a32b0c2 100644 --- a/contributing.md +++ b/contributing.md @@ -46,8 +46,18 @@ you'll need a recent nightly compiler to build it. git clone https://github.com/rust-lang/rls.git cd rls cargo build --release -``` +`````` + +#### If RLS couldn't be built with clippy + +Sometimes nightly toolchain changes break the `clippy_lints` dependency. +Since RLS depends on `clippy_lints` by default, those changes can also break RLS itself. +In this case, you can build RLS like this: + +`cargo build --no-default-features` (disabling the clippy feature) +And sometimes git revision of `clippy` submodule in the Rust repo (https://github.com/rust-lang/rust/tree/master/src/tools) and `clippy_lints` dependency of RLS is different. +In this case, submit a PR here updating the `clippy_lints` dependency to the git revision pulled from the Rust tree. ### Step 3: Connect the RLS to your compiler