From 43ce2c2844ebe1918716a1e599b159a0eb5885cd Mon Sep 17 00:00:00 2001 From: Joshua Nelson Date: Sat, 31 Oct 2020 15:06:06 -0400 Subject: [PATCH] Improve contributing instructions - Fix incorrect comment - Recommend `x.py setup` over manually editing config.toml - Link to rustc-dev-guide --- CONTRIBUTING.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08dcd541f7bf..bbfcb7638f38 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -144,8 +144,9 @@ The setup for a local rustc works as follows: # Clone the rust-lang/rust repo. git clone https://github.com/rust-lang/rust rustc cd rustc -cp config.toml.example config.toml -# Now edit `config.toml` and set `debug-assertions = true`. +# Create a config.toml with defaults for working on miri. +./x.py setup compiler + # Now edit `config.toml` and under `[rust]` set `debug-assertions = true`. # Build a stage 1 rustc, and build the rustc libraries with that rustc. # This step can take 30 minutes or more. @@ -158,5 +159,8 @@ rustup toolchain link stage1 build/x86_64-unknown-linux-gnu/stage1 rustup override set stage1 ``` +For more information about building and configuring a local compiler, +see . + With this, you should now have a working development setup! See [above](#building-and-testing-miri) for how to proceed working on Miri.