Skip to content

Commit

Permalink
Rollup merge of rust-lang#44664 - budziq:contributing_external, r=ste…
Browse files Browse the repository at this point in the history
…veklabnik

Corrected the CONTRIBUTING.md "External Dependencies" section

The "External Dependencies" section is a little outdated.
Please see following comments rust-lang#44567 (comment) rust-lang#44567 (comment) for rationale.
  • Loading branch information
kennytm authored Oct 5, 2017
2 parents a0db04b + e6c3c7f commit b34ade0
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit b34ade0

Please sign in to comment.