diff options
| author | flip1995 <hello@philkrones.com> | 2019-07-04 14:35:27 +0200 |
|---|---|---|
| committer | flip1995 <hello@philkrones.com> | 2019-07-07 15:11:38 +0200 |
| commit | 3977843ab5592f8fb9c20f7f8436bae362234c52 (patch) | |
| tree | 7410dbf87f7078f67c8dcf6224b02cb14179c9b5 | |
| parent | 0c00391ed060c9184f520639bf5f51e650057d3d (diff) | |
| download | rust-3977843ab5592f8fb9c20f7f8436bae362234c52.tar.gz rust-3977843ab5592f8fb9c20f7f8436bae362234c52.zip | |
Update documentation to the dev fmt command
| -rw-r--r-- | doc/adding_lints.md | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/adding_lints.md b/doc/adding_lints.md index 2a8ef01ba1d..0e73bdba108 100644 --- a/doc/adding_lints.md +++ b/doc/adding_lints.md @@ -345,16 +345,18 @@ list][lint_list]. ### Running rustfmt -[Rustfmt](https://github.com/rust-lang/rustfmt) is a tool for formatting Rust code according -to style guidelines. Your code has to be formatted by `rustfmt` before a PR can be merged. +[Rustfmt](https://github.com/rust-lang/rustfmt) is a tool for formatting Rust +code according to style guidelines. Your code has to be formatted by `rustfmt` +before a PR can be merged. Clippy uses nightly `rustfmt` in the CI. It can be installed via `rustup`: ```bash -rustup component add rustfmt +rustup component add rustfmt --toolchain=nightly ``` -Use `cargo fmt --all` to format the whole codebase. +Use `./util/dev fmt` to format the whole codebase. Make sure that `rustfmt` is +installed for the nightly toolchain. ### Debugging @@ -371,7 +373,7 @@ Before submitting your PR make sure you followed all of the basic requirements: - [ ] `cargo test` passes locally - [ ] Executed `util/dev update_lints` - [ ] Added lint documentation -- [ ] Run `cargo fmt` +- [ ] Run `./util/dev fmt` ### Cheatsheet |