diff options
| author | Michal Budzynski <budziq@gmail.com> | 2017-09-18 01:24:29 +0200 |
|---|---|---|
| committer | Michal Budzynski <budziq@gmail.com> | 2017-10-02 00:18:19 +0200 |
| commit | e6c3c7f2dce7f66ae96c5dbd3a737bd96108ab21 (patch) | |
| tree | 97166422ba0a36c03d0a2c162ae4210c7594acab | |
| parent | f1b5225e8b67adab52dda2b5ed5c8b805b716a6d (diff) | |
| download | rust-e6c3c7f2dce7f66ae96c5dbd3a737bd96108ab21.tar.gz rust-e6c3c7f2dce7f66ae96c5dbd3a737bd96108ab21.zip | |
Corrected the CONTRIBUTING.md "External Dependencies" section
| -rw-r--r-- | CONTRIBUTING.md | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3834c54d6c4..ac89462e492 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -333,8 +333,18 @@ Currently building Rust will also build the following external projects: * [miri](https://github.com/solson/miri) If your changes break one of these projects, you need to fix them by opening -a pull request against the broken project. When you have opened a pull request, -you can disable the tool via `src/tools/toolstate.toml`. +a pull request against the broken project asking to put the fix on a branch. +Then you can disable the tool building via `src/tools/toolstate.toml`. +Once the branch containing your fix is likely to be merged, you can point +the affected submodule at this branch. + +Don't forget to also add your changes with + +``` +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. |