Skip to content

Commit f196aeb

Browse files
committed
Improve contributing instructions
- Fix incorrect comment - Recommend `x.py setup` over manually editing config.toml - Link to rustc-dev-guide
1 parent 85a9a43 commit f196aeb

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

CONTRIBUTING.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,8 @@ The setup for a local rustc works as follows:
144144
# Clone the rust-lang/rust repo.
145145
git clone https://github.com/rust-lang/rust rustc
146146
cd rustc
147-
cp config.toml.example config.toml
148-
# Now edit `config.toml` and set `debug-assertions = true`.
147+
# Create a config.toml with defaults for working on miri
148+
./x.py setup compiler
149149

150150
# Build a stage 1 rustc, and build the rustc libraries with that rustc.
151151
# This step can take 30 minutes or more.
@@ -158,5 +158,8 @@ rustup toolchain link stage1 build/x86_64-unknown-linux-gnu/stage1
158158
rustup override set stage1
159159
```
160160

161+
For more information about building and configuring a local compiler,
162+
see <https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html>.
163+
161164
With this, you should now have a working development setup! See
162165
[above](#building-and-testing-miri) for how to proceed working on Miri.

0 commit comments

Comments
 (0)