From e9b8781d1fa3c55ea4fd7a8e5068cbc46084a10b Mon Sep 17 00:00:00 2001 From: Bugen Zhao Date: Fri, 19 Jan 2024 14:37:05 +0800 Subject: [PATCH] update instruction in root toolchain file Signed-off-by: Bugen Zhao --- ci/rust-toolchain | 4 ++-- lints/README.md | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/ci/rust-toolchain b/ci/rust-toolchain index e8c05a601edc0..b1f2df70a8d0f 100644 --- a/ci/rust-toolchain +++ b/ci/rust-toolchain @@ -1,7 +1,7 @@ # To update toolchain, do the following: # 1. update this file -# 2. update lints/rust-toolchain, lints/Cargo.toml -# 3. update ci/build-ci-image.sh and ci/docker-compose.yml to build a new CI image +# 2. update ci/build-ci-image.sh and ci/docker-compose.yml to build a new CI image +# 3. (optional) **follow the instructions in lints/README.md** to update the toolchain and dependencies for lints [toolchain] channel = "nightly-2023-12-26" diff --git a/lints/README.md b/lints/README.md index 6f321f7711ff9..ba8a7aebb9210 100644 --- a/lints/README.md +++ b/lints/README.md @@ -38,3 +38,5 @@ The information below can be helpful in finding the appropriate version to bump - The toolchain used by the latest version of `cargo-dylint`: https://github.com/trailofbits/dylint/blob/master/internal/template/rust-toolchain - The toolchain used by the latest version of `clippy`: https://github.com/rust-lang/rust-clippy/blob/master/rust-toolchain - The hash of the latest commit in `rust-lang/rust-clippy` repo for the dependency `clippy-utils`. + +Run the lints after bumping the toolchain to verify it works.