Auto merge of #1699 - m-ou-se:panic-format, r=RalfJung

[rust.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 20f01f151a6502542a4b2a116f68de3ebf59bffa..bbfcb7638f382b2a279867cbc3771e514c224b27 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -144,10 +144,11 @@ 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.
+# Build a stage 1 rustc, and build the rustc libraries with that rustc.
 # This step can take 30 minutes or more.
 ./x.py build --stage 1 compiler/rustc
 # If you change something, you can get a faster rebuild by doing
@@ -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 <https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html>.
+
 With this, you should now have a working development setup! See
 [above](#building-and-testing-miri) for how to proceed working on Miri.