summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMichal Budzynski <budziq@gmail.com>2017-09-18 01:24:29 +0200
committerMichal Budzynski <budziq@gmail.com>2017-10-02 00:18:19 +0200
commite6c3c7f2dce7f66ae96c5dbd3a737bd96108ab21 (patch)
tree97166422ba0a36c03d0a2c162ae4210c7594acab /CONTRIBUTING.md
parentAuto merge of #44919 - diwic:79-pretty-mir, r=arielb1 (diff)
downloadgrust-e6c3c7f2dce7f66ae96c5dbd3a737bd96108ab21.tar.gz
grust-e6c3c7f2dce7f66ae96c5dbd3a737bd96108ab21.tar.bz2
grust-e6c3c7f2dce7f66ae96c5dbd3a737bd96108ab21.tar.xz
Corrected the CONTRIBUTING.md "External Dependencies" section
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3834c54d6c..ac89462e49 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -333,8 +333,18 @@ Currently building Rust will also build the following external projects:
333* [miri](https://github.com/solson/miri) 333* [miri](https://github.com/solson/miri)
334 334
335If your changes break one of these projects, you need to fix them by opening 335If your changes break one of these projects, you need to fix them by opening
336a pull request against the broken project. When you have opened a pull request, 336a pull request against the broken project asking to put the fix on a branch.
337you can disable the tool via `src/tools/toolstate.toml`. 337Then you can disable the tool building via `src/tools/toolstate.toml`.
338Once the branch containing your fix is likely to be merged, you can point
339the affected submodule at this branch.
340
341Don't forget to also add your changes with
342
343```
344git add path/to/submodule
345```
346
347outside the submodule.
338 348
339It can also be more convenient during development to set `submodules = false` 349It can also be more convenient during development to set `submodules = false`
340in the `config.toml` to prevent `x.py` from resetting to the original branch. 350in the `config.toml` to prevent `x.py` from resetting to the original branch.