Make the docs clearer for new contributors #5874
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @matthiaskrgr (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
rust-highfive
added
the
S-waiting-on-review
|
This is already described in |
flip1995
added
S-waiting-on-author
|
r? @flip1995 |
doc/basics.md
Outdated
| **Note:** You may get compiler errors when building Clippy, even if you | ||
| didn't change anything. That's because, as mentioned earlier, Clippy | ||
| depends on rustc internals. There is [discussion][nightly-build-issue] | ||
| on ways to make sure that rustc does not break Clippy in the future | ||
| so that Clippy always builds. |
There was a problem hiding this comment.
Should we mention that this is called a tool breakage and link to forge docs?
There was a problem hiding this comment.
No, this is different from classic tool breakages.
There was a problem hiding this comment.
Hmm, I guess I didn't realize that. Are there docs that talk about the differences between classic tool breakages and clippy tool breakages?
There was a problem hiding this comment.
Yeah, see https://rustc-dev-guide.rust-lang.org/contributing.html#external-dependencies-subtree and the following section.
TL;DR: Clippy breakages will never appear in nightlies delivered with rustups, so they aren't user facing.
There was a problem hiding this comment.
So when there's an internal breaking change, clippy is updated in rust-lang/rust, but then has to be brought over to this repository (rust-lang/rust-clippy)?
* Add an easy-to-see note at the top of `CONTRIBUTING.md` that points new contributors to the Basics docs * Add a note about compiler errors as a result of internals changes that break Clippy
flip1995
added
S-waiting-on-bors
|
@bors r+ rollup |
|
📌 Commit bd71b01 has been approved by |
Rollup of 5 pull requests Successful merges: - #5825 (Add the new lint `same_item_push`) - #5869 (New lint against `Self` as an arbitrary self type) - #5870 (enable #[allow(clippy::unsafe_derive_deserialize)]) - #5871 (Lint .min(x).max(y) with x < y) - #5874 (Make the docs clearer for new contributors) Failed merges: r? @ghost changelog: rollup
It confused me before, so I made it extra obvious that you need to run
a script to set up your toolchain before you can build Clippy.
I also added a note so that new contributors aren't confused when
Clippy doesn't build as a result of a change in rustc's internals.
changelog: make
CONTRIBUTING.mdclearer for new contributors