-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Add clippy as a submodule #43886
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add clippy as a submodule #43886
Changes from 2 commits
1766992
49fca85
f467776
b9e4bdb
93a9183
20f1e68
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. might need a There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we should test this workflow on a test repo. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm doing that right now with the Cargo.lock |
||
``` | ||
|
||
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` | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this documentation may wish to be updated with the current state of the PR