11# Handling of tools embedded in the rustc repo ("toolstate")
22
33The Rust repository contains several external tools and documents as git
4- submodules (e.g. miri, rls, the [ Book] , the [ Reference] ). Many of those are
4+ submodules (e.g. miri, the [ Book] , the [ Reference] ). Some of those are
55very tightly coupled to the compiler and depend on internal APIs that change all
66the time, but they are not actually essential to get the compiler itself to
77work. To make API changes less painful, these tools are allowed to "break"
@@ -31,8 +31,8 @@ rules are for when which tools are (not) allowed to break.
3131 cut. (See the [ Forge index] [ forge ] for when the next beta cutoff is
3232 happening.)
3333
34- At the time of writing, the following tools are "nightly only": rustc-dev-guide,
35- miri, RLS, embedded-book.
34+ At the time of writing, the following tools are "nightly only":
35+ miri, embedded-book.
3636
3737## Updating the toolstate repository
3838
@@ -57,7 +57,7 @@ Tools can be updated by updating the submodule to the proper commit.
5757Run ` git submodule update --remote path/to/submodule ` , add the updates, make
5858sure the tests pass, commit, and send a pull request. The path is from the
5959root of the rust repository, so for example, the reference is
60- ` src/doc/reference ` and rls is ` src/tools/rls ` .
60+ ` src/doc/reference ` and miri is ` src/tools/miri ` .
6161
6262While not required, [ subup] may assist you with this.
6363
0 commit comments