Skip to content

Commit fa25109

Browse files
committed
Rewrite expanded ci-check-msrv doc so just --list works
This rewrites the newly expanded multi-line comment explaining what the `ci-check-msrv` recipe in the `justfile` does, so that it is still readable from top to bottom, but so that the one-line summary is the last line. This is needed because `just --list` only treats a single `#` line, preceding the formal beginning of the recipe, as its documentation. (This differs from most other uses of multi-line comments, such as in a Rust `///` or `//!` comment, where the first line could be a short summary, and subsequent paragraphs are regarded subordinate.)
1 parent 5f75b6c commit fa25109

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

justfile

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -238,11 +238,12 @@ cross-test-android: (cross-test 'armv7-linux-androideabi' '--no-default-features
238238
check-size:
239239
etc/check-package-size.sh
240240

241-
# Assume the current default toolchain is the Minimal Supported Rust Version and check against it
241+
# This assumes the current default toolchain is the Minimal Supported Rust Version and checks
242+
# against it. This is run on CI in `msrv.yml`, after the MSRV toolchain is installed and set as
243+
# default, and after dependencies in `Cargo.lock` are downgraded to the latest MSRV-compatible
244+
# versions. Only if those or similar steps are done first does this work to validate the MSRV.
242245
#
243-
# This is run on CI in `msrv.yml`, after the MSRV toolchain is installed and set as default, and
244-
# after dependencies in `Cargo.lock` are downgraded to the latest MSRV-compatible versions.
245-
# Only if those or similar steps are done first does this recipe really validate the MSRV.
246+
# Check the MSRV, *if* the toolchain is set and `Cargo.lock` is downgraded (used on CI)
246247
ci-check-msrv:
247248
rustc --version
248249
cargo check -p gix

0 commit comments

Comments
 (0)