update instruction in root toolchain file

Signed-off-by: Bugen Zhao <[email protected]>
risingwavelabs · Jan 19, 2024 · e9b8781 · e9b8781
1 parent 23278d4
commit e9b8781
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git 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
@@ -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.