about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
authorRajkumar Natarajan <rajkumar.natarajan@synacor.com>2018-05-10 08:09:56 -0400
committerRajkumar Natarajan <rajkumar.natarajan@synacor.com>2018-05-10 08:14:43 -0400
commitadd87abefc2d127d916126b27be19ab028ff8fd9 (patch)
treef318b671c76731e9bc69f56d271e7a9e4054bbd1 /src
parentb787599f9ed85d9c51ebdedb9d2270d9451ae473 (diff)
downloadrust-add87abefc2d127d916126b27be19ab028ff8fd9.tar.gz
rust-add87abefc2d127d916126b27be19ab028ff8fd9.zip
Issue84 Add note about ./x.py build
Diffstat (limited to 'src')
-rw-r--r--src/doc/rustc-dev-guide/src/how-to-build-and-run.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/how-to-build-and-run.md b/src/doc/rustc-dev-guide/src/how-to-build-and-run.md
index 493f642a5b2..66c73654824 100644
--- a/src/doc/rustc-dev-guide/src/how-to-build-and-run.md
+++ b/src/doc/rustc-dev-guide/src/how-to-build-and-run.md
@@ -75,6 +75,11 @@ internally. The result is the compiling `rustc` is done in stages.
 For hacking, often building the stage 1 compiler is enough, but for
 final testing and release, the stage 2 compiler is used.
 
+`./x.py check` is really fast to build the rust compiler. 
+It is, in particular, very useful when you're doing some kind of 
+"type-based refactoring", like renaming a method, or changing the 
+signature of some function.
+
 Once you've created a config.toml, you are now ready to run
 `x.py`. There are a lot of options here, but let's start with what is
 probably the best "go to" command for building a local rust: