Skip to content

Commit b34ade0

Browse files
authored
Rollup merge of rust-lang#44664 - budziq:contributing_external, r=steveklabnik
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.
2 parents a0db04b + e6c3c7f commit b34ade0

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

CONTRIBUTING.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -333,8 +333,18 @@ Currently building Rust will also build the following external projects:
333333
* [miri](https://github.com/solson/miri)
334334

335335
If your changes break one of these projects, you need to fix them by opening
336-
a pull request against the broken project. When you have opened a pull request,
337-
you can disable the tool via `src/tools/toolstate.toml`.
336+
a pull request against the broken project asking to put the fix on a branch.
337+
Then you can disable the tool building via `src/tools/toolstate.toml`.
338+
Once the branch containing your fix is likely to be merged, you can point
339+
the affected submodule at this branch.
340+
341+
Don't forget to also add your changes with
342+
343+
```
344+
git add path/to/submodule
345+
```
346+
347+
outside the submodule.
338348

339349
It can also be more convenient during development to set `submodules = false`
340350
in the `config.toml` to prevent `x.py` from resetting to the original branch.

0 commit comments

Comments
 (0)