Skip to content

Commit fdfcedd

Browse files
committed
Lightly revise recipe descriptions and add missing ones
- Make the style of `justfile` recipe descriptions more consistent - Lightly adjust wording and punctuaiton for clarity - Clarify some to avert misreadings even if a reader is inattentive - Add descriptions for the several recipes that didn't have them
1 parent 151797f commit fdfcedd

File tree

1 file changed

+23
-20
lines changed

1 file changed

+23
-20
lines changed

justfile

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,35 @@
44

55
j := quote(just_executable())
66

7+
# List available recipes
78
default:
89
{{ j }} --list
910

1011
alias t := test
1112
alias c := check
1213
alias nt := nextest
1314

14-
# run all tests, clippy, including journey tests, try building docs
15+
# Run all tests, clippy, including journey tests, try building docs
1516
test: clippy check doc unit-tests journey-tests-pure journey-tests-small journey-tests-async journey-tests check-mode
1617

17-
# run all tests, without clippy, and try building docs
18+
# Run all tests, without clippy, and try building docs
1819
ci-test: check doc unit-tests check-mode
1920

20-
# run all journey tests - should be run in a fresh clone or after `cargo clean`
21+
# Run all journey tests - should be run in a fresh clone or after `cargo clean`
2122
ci-journey-tests: journey-tests-pure journey-tests-small journey-tests-async journey-tests
2223

24+
# Clean the `target` directory
2325
clear-target:
2426
cargo clean
2527

26-
# Run cargo clippy on all crates
28+
# Run `cargo clippy` on all crates
2729
clippy *clippy-args:
2830
cargo clippy --workspace --all-targets -- {{ clippy-args }}
2931
cargo clippy --workspace --no-default-features --features small -- {{ clippy-args }}
3032
cargo clippy --workspace --no-default-features --features max-pure -- {{ clippy-args }}
3133
cargo clippy --workspace --no-default-features --features lean-async --tests -- {{ clippy-args }}
3234

33-
# Run cargo clippy on all crates, fixing what can be fixed, and format all code
35+
# Run `cargo clippy` on all crates, fixing what can be fixed, and format all code
3436
clippy-fix:
3537
cargo clippy --fix --workspace --all-targets
3638
cargo clippy --fix --allow-dirty --workspace --no-default-features --features small
@@ -145,12 +147,12 @@ check:
145147
cargo check -p gix-odb --features serde
146148
cargo check --no-default-features --features max-control
147149

148-
# Run cargo doc on all crates
150+
# Run `cargo doc` on all crates
149151
doc $RUSTDOCFLAGS='-D warnings':
150152
cargo doc --workspace --no-deps --features need-more-recent-msrv
151153
cargo doc --features=max,lean,small --workspace --no-deps --features need-more-recent-msrv
152154

153-
# run all unit tests
155+
# Run all unit tests
154156
unit-tests:
155157
cargo nextest run
156158
cargo test --doc
@@ -193,71 +195,72 @@ unit-tests:
193195
unit-tests-flaky:
194196
cargo test -p gix --features async-network-client-async-std
195197

196-
# depend on this to pre-generate metadata, and/or use it inside a recipe as `"$({{ j }} dbg)"`
198+
# Depend on this to pre-generate metadata, and/or use it inside a recipe as `"$({{ j }} dbg)"`
197199
[private]
198200
dbg:
199201
set -eu; \
200202
target_dir="$(cargo metadata --format-version 1 | jq -r .target_directory)"; \
201203
test -n "$target_dir"; \
202204
echo "$target_dir/debug"
203205

204-
# run journey tests (max)
206+
# Run journey tests (`max`)
205207
journey-tests: dbg
206208
cargo build --features http-client-curl-rustls
207209
cargo build -p gix-testtools --bin jtt
208210
dbg="$({{ j }} dbg)" && tests/journey.sh "$dbg/ein" "$dbg/gix" "$dbg/jtt" max
209211

210-
# run journey tests (max-pure)
212+
# Run journey tests (`max-pure`)
211213
journey-tests-pure: dbg
212214
cargo build --no-default-features --features max-pure
213215
cargo build -p gix-testtools --bin jtt
214216
dbg="$({{ j }} dbg)" && tests/journey.sh "$dbg/ein" "$dbg/gix" "$dbg/jtt" max-pure
215217

216-
# run journey tests (small)
218+
# Run journey tests (`small`)
217219
journey-tests-small: dbg
218220
cargo build --no-default-features --features small
219221
cargo build -p gix-testtools
220222
dbg="$({{ j }} dbg)" && tests/journey.sh "$dbg/ein" "$dbg/gix" "$dbg/jtt" small
221223

222-
# run journey tests (lean-async)
224+
# Run journey tests (`lean-async`)
223225
journey-tests-async: dbg
224226
cargo build --no-default-features --features lean-async
225227
cargo build -p gix-testtools
226228
dbg="$({{ j }} dbg)" && tests/journey.sh "$dbg/ein" "$dbg/gix" "$dbg/jtt" async
227229

228-
# Run cargo-diet on all crates to see that they are still in bound
230+
# Run `cargo diet` on all crates to see that they are still in bounds
229231
check-size:
230232
etc/check-package-size.sh
231233

232-
# Check the minimal support rust version for currently installed Rust version
234+
# Check the minimal support Rust version, with the currently installed Rust version
233235
ci-check-msrv:
234236
rustc --version
235237
cargo check -p gix
236238
cargo check -p gix --no-default-features --features async-network-client,max-performance
237239

238-
# Enter a nix-shell able to build on macos
240+
# Enter a nix-shell able to build on macOS
239241
nix-shell-macos:
240242
nix-shell -p pkg-config openssl libiconv darwin.apple_sdk.frameworks.Security darwin.apple_sdk.frameworks.SystemConfiguration
241243

242-
# run various auditing tools to assure we are legal and safe
244+
# Run various auditing tools to help us stay legal and safe
243245
audit:
244246
cargo deny check advisories bans licenses sources
245247

246-
# run tests with `cargo nextest` (all unit-tests, no doc-tests, faster)
248+
# Run tests with `cargo nextest` (all unit-tests, no doc-tests, faster)
247249
nextest *FLAGS='--workspace':
248250
cargo nextest run {{ FLAGS }}
249251

252+
# Run tests with `cargo nextest`, skipping none except as filtered, omitting status reports
250253
summarize EXPRESSION='all()':
251254
cargo nextest run --workspace --run-ignored all --no-fail-fast \
252255
--status-level none --final-status-level none -E {{ quote(EXPRESSION) }}
253256

254-
# run nightly rustfmt for its extra features, but check that it won't upset stable rustfmt
257+
# Run nightly `rustfmt` for its extra features, but check that it won't upset stable `rustfmt`
255258
fmt:
256259
cargo +nightly fmt --all -- --config-path rustfmt-nightly.toml
257260
cargo +stable fmt --all -- --check
258261
{{ j }} --fmt --unstable
259262

260-
# Cancel this after the first few seconds, as yanked crates will appear in warnings.
263+
# Cancel this after the first few seconds, as yanked crates will appear in warnings
261264
find-yanked:
262265
cargo install --debug --locked --no-default-features --features max-pure --path .
263266

@@ -266,6 +269,6 @@ check-mode:
266269
cargo build -p internal-tools
267270
cargo run -p internal-tools -- check-mode
268271

269-
# Delete gix-packetline-blocking/src and regenerate from gix-packetline/src
272+
# Delete `gix-packetline-blocking/src` and regenerate from `gix-packetline/src`
270273
copy-packetline:
271274
etc/copy-packetline.sh

0 commit comments

Comments
 (0)