From 0114c4b31271399b47b7aa8affd9e6ff03c0d413 Mon Sep 17 00:00:00 2001 From: Daniel Verkamp Date: Mon, 13 Jul 2020 16:54:34 -0700 Subject: [PATCH] readme: add a note about clippy Mention the bin/clippy script in the Code Health section. BUG=None TEST=read the readme Change-Id: Idb55affd5240a85ae434b54360a418e8ef1d40c1 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2296504 Tested-by: Daniel Verkamp Tested-by: kokoro Auto-Submit: Daniel Verkamp Reviewed-by: Dylan Reid Commit-Queue: Dylan Reid --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index d74e41e1bb..9aeba06110 100644 --- a/README.md +++ b/README.md @@ -208,6 +208,12 @@ checking in a change. This is different from `cargo fmt --all` which formats multiple crates but a single workspace only; crosvm consists of multiple workspaces. +#### `clippy` + +The `clippy` linter is used to check for common Rust problems. The crosvm +project uses a specific set of `clippy` checks; please run `bin/clippy` before +checking in a change. + #### Dependencies With a few exceptions, external dependencies inside of the `Cargo.toml` files