diff options
author | bors <bors@rust-lang.org> | 2017-09-02 17:17:14 +0000 |
---|---|---|
committer | bors <bors@rust-lang.org> | 2017-09-02 17:17:14 +0000 |
commit | 204c0a47e7b7e371cf1cdc159404d405b86386ba (patch) | |
tree | 23704d30ca5656cae4f2637cecd8034f6096932a /CONTRIBUTING.md | |
parent | Auto merge of #44259 - Mark-Simulacrum:update-cargo, r=alexcrichton (diff) | |
parent | Require adding clippy's path to the `x.py` invocation (diff) | |
download | grust-204c0a47e7b7e371cf1cdc159404d405b86386ba.tar.gz grust-204c0a47e7b7e371cf1cdc159404d405b86386ba.tar.bz2 grust-204c0a47e7b7e371cf1cdc159404d405b86386ba.tar.xz |
Auto merge of #43886 - oli-obk:clippy, r=nrc
Add clippy as a submodule
~~This builds clippy as part of `./x.py build` (locally and in CI).~~
This allows building clippy with `./x.py build src/tools/clippy`
~~Needs https://github.com/nrc/dev-tools-team/issues/18#issuecomment-322456461 to be resolved before it can be merged.~~ Contributers can simply open a PR to clippy and point the submodule at the `pull/$pr_number/head` branch.
This does **not** build clippy or test the clippy test suite at all as per https://github.com/nrc/dev-tools-team/issues/18#issuecomment-321411418
r? @nrc
cc @Manishearth @llogiq @mcarton @alexcrichton
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c424ca7ab0..cdac8e696c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
@@ -298,6 +298,32 @@ Speaking of tests, Rust has a comprehensive test suite. More information about | |||
298 | it can be found | 298 | it can be found |
299 | [here](https://github.com/rust-lang/rust-wiki-backup/blob/master/Note-testsuite.md). | 299 | [here](https://github.com/rust-lang/rust-wiki-backup/blob/master/Note-testsuite.md). |
300 | 300 | ||
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 fetch origin pull/$id_of_your_pr/head:my_pr | ||
313 | git checkout my_pr | ||
314 | ``` | ||
315 | |||
316 | within the submodule's directory. Don't forget to also add your changes with | ||
317 | |||
318 | ``` | ||
319 | git add path/to/submodule | ||
320 | ``` | ||
321 | |||
322 | outside the submodule. | ||
323 | |||
324 | It can also be more convenient during development to set `submodules = false` | ||
325 | in the `config.toml` to prevent `x.py` from resetting to the original branch. | ||
326 | |||
301 | ## Writing Documentation | 327 | ## Writing Documentation |
302 | 328 | ||
303 | Documentation improvements are very welcome. The source of `doc.rust-lang.org` | 329 | Documentation improvements are very welcome. The source of `doc.rust-lang.org` |