Skip to content

Commit f6f83e2

Browse files
RalfJungjyn514
authored andcommitted
improve section introduction
1 parent 99e60b3 commit f6f83e2

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

src/contributing.md

+10-13
Original file line numberDiff line numberDiff line change
@@ -258,19 +258,16 @@ before the PR is merged.
258258

259259
#### Breaking Tools Built With The Compiler
260260

261-
Rust's build system builds a number of tools that make use of the
262-
internals of the compiler. This includes
263-
[RLS](https://github.com/rust-lang/rls) and
264-
[miri](https://github.com/rust-lang/miri). If these tools
265-
break because of your changes, you may run into a sort of "chicken and egg"
266-
problem. These tools rely on the latest compiler to be built so you can't update
267-
them to reflect your changes to the compiler until those changes are merged into
268-
the compiler. At the same time, you can't get your changes merged into the compiler
269-
because the rust-lang/rust build won't pass until those tools build and pass their
270-
tests.
271-
272-
That would mean that, in the default state, you couldn't update the compiler without first
273-
fixing miri, rls and the other tools that the compiler builds.
261+
Rust's build system builds a number of tools that make use of the internals of
262+
the compiler and that are hosted in a separate repository, and included in Rust
263+
via git submodules. This includes [RLS](https://github.com/rust-lang/rls) and
264+
[Miri](https://github.com/rust-lang/Miri). If these tools break because of your
265+
changes, you may run into a sort of "chicken and egg" problem. These tools rely
266+
on the latest compiler to be built so you can't update them (in their own
267+
repositories) to reflect your changes to the compiler until those changes are
268+
merged into the compiler. At the same time, you can't get your changes merged
269+
into the compiler because the rust-lang/rust build won't pass until those tools
270+
build and pass their tests.
274271

275272
Luckily, a feature was
276273
[added to Rust's build](https://github.com/rust-lang/rust/issues/45861) to make

0 commit comments

Comments
 (0)