about summary refs log tree commit diff
diff options
context:
space:
mode:
authorOliver Schneider <git-spam-no-reply9815368754983@oli-obk.de>2017-08-15 18:06:10 +0200
committerOliver Schneider <git-spam-no-reply9815368754983@oli-obk.de>2017-08-15 18:06:10 +0200
commit49fca85b1902e599f8c3dadece7de85ecc6cbd06 (patch)
treec305ac0de938fcd2999cdc13e82f960cf564a9ca
parent1766992662cfed57047760b908fc1afc2bcaede0 (diff)
downloadrust-49fca85b1902e599f8c3dadece7de85ecc6cbd06.tar.gz
rust-49fca85b1902e599f8c3dadece7de85ecc6cbd06.zip
Document the process of updating external dependencies
-rw-r--r--CONTRIBUTING.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9c54dfd3388..8258b68841b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -298,6 +298,31 @@ Speaking of tests, Rust has a comprehensive test suite. More information about
 it can be found
 [here](https://github.com/rust-lang/rust-wiki-backup/blob/master/Note-testsuite.md).
 
+### External Dependencies
+
+Currently building Rust will also build the following external projects:
+
+* [clippy](https://github.com/rust-lang-nursery/rust-clippy)
+
+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 point the submodule at your pull request by calling
+
+```
+git checkout pulls/$id_of_your_pr/head
+```
+
+within the submodule's directory. 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.
+
 ## Writing Documentation
 
 Documentation improvements are very welcome. The source of `doc.rust-lang.org`