Skip to content

Commit 49fca85

Browse files
committed
Document the process of updating external dependencies
1 parent 1766992 commit 49fca85

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CONTRIBUTING.md

+25
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,31 @@ Speaking of tests, Rust has a comprehensive test suite. More information about
298298
it can be found
299299
[here](https://github.com/rust-lang/rust-wiki-backup/blob/master/Note-testsuite.md).
300300

301+
### External Dependencies
302+
303+
Currently building Rust will also build the following external projects:
304+
305+
* [clippy](https://github.com/rust-lang-nursery/rust-clippy)
306+
307+
If your changes break one of these projects, you need to fix them by opening
308+
a pull request against the broken project. When you have opened a pull request,
309+
you can point the submodule at your pull request by calling
310+
311+
```
312+
git checkout pulls/$id_of_your_pr/head
313+
```
314+
315+
within the submodule's directory. Don't forget to also add your changes with
316+
317+
```
318+
git add path/to/submodule
319+
```
320+
321+
outside the submodule.
322+
323+
It can also be more convenient during development to set `submodules = false`
324+
in the `config.toml` to prevent `x.py` from resetting to the original branch.
325+
301326
## Writing Documentation
302327

303328
Documentation improvements are very welcome. The source of `doc.rust-lang.org`

0 commit comments

Comments
 (0)