about summary refs log tree commit diff
diff options
context:
space:
mode:
authorNiko Matsakis <niko@alum.mit.edu>2017-09-21 13:46:52 -0400
committerNiko Matsakis <niko@alum.mit.edu>2017-10-16 17:32:22 -0400
commit09caa12a51cb61a9841ac072103b6300aa5fb1fd (patch)
tree304801529cdf828b2701472917abef5fc18d3a9f
parent47449ea513955f278e8838a132a0c71655c54abf (diff)
downloadrust-09caa12a51cb61a9841ac072103b6300aa5fb1fd.tar.gz
rust-09caa12a51cb61a9841ac072103b6300aa5fb1fd.zip
add some tips to CONTRIBUTING.md to help with debugging this problem
-rw-r--r--CONTRIBUTING.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a86742d7bd4..d67a74f681e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -360,8 +360,10 @@ git add path/to/submodule
 
 outside the submodule.
 
-It can also be more convenient during development to set `submodules = false`
-in the `config.toml` to prevent `x.py` from resetting to the original branch.
+In order to prepare your PR, you can run the build locally by doing
+`./x.py build src/tools/TOOL`. If you will be editing the sources
+there, you may wish to set `submodules = false` in the `config.toml`
+to prevent `x.py` from resetting to the original branch.
 
 ## Writing Documentation
 [writing-documentation]: #writing-documentation