OpenE2K
/
rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Corrected the CONTRIBUTING.md "External Dependencies" section

This commit is contained in:
Michal Budzynski 2017-09-18 01:24:29 +02:00
parent f1b5225e8b
commit e6c3c7f2dc
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -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.