From 2121be4d189a7a03f989c7f81d2f1983aa526a80 Mon Sep 17 00:00:00 2001 From: xtqqczze <45661989+xtqqczze@users.noreply.github.com> Date: Fri, 3 Apr 2026 14:05:25 +0100 Subject: [PATCH 1/2] pre-commit: remove rust-clippy for speed --- .pre-commit-config.yaml | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 198ccb2087a..1fc1bbb0ab3 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -37,13 +37,6 @@ repos: pass_filenames: true types: [file, rust] language: system - - id: rust-clippy - name: Rust clippy - description: Run cargo clippy on files included in the commit. - entry: cargo +stable clippy --frozen --workspace --all-targets --all-features -- -D warnings - pass_filenames: false - types: [file, rust] - language: system - id: cargo-lock-check name: Cargo.lock sync check description: Ensure Cargo.lock and fuzz/Cargo.lock are up-to-date. @@ -59,4 +52,4 @@ repos: language: system ci: - skip: [rust-linting, rust-clippy, cargo-lock-check, cspell] + skip: [rust-linting, cargo-lock-check, cspell] From 583c00d3bca7fa7ef706f16434df34e6e345b77b Mon Sep 17 00:00:00 2001 From: xtqqczze <45661989+xtqqczze@users.noreply.github.com> Date: Fri, 3 Apr 2026 14:12:28 +0100 Subject: [PATCH 2/2] docs: simplify development tooling docs and clarify caveats --- DEVELOPMENT.md | 23 +++++++++-------------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 35291369c12..34df86397e8 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -52,30 +52,25 @@ For MacOS and Windows platform specific setup please check [MacOS GNU utils](#ma ### pre-commit hooks -A configuration for `pre-commit` is provided in the repository. It allows -automatically checking every git commit you make to ensure it compiles, and -passes `clippy` and `rustfmt` without warnings. +A `pre-commit` configuration is included in the repository to run various checks on each commit. -To use the provided hook: +To enable the hooks: 1. [Install `pre-commit`](https://pre-commit.com/#install) -1. Run `pre-commit install` while in the repository directory +1. Run `pre-commit install` in the repository -Your git commits will then automatically be checked. If a check fails, an error -message will explain why, and your commit will be canceled. You can then make -the suggested changes, and run `git commit ...` again. - -**NOTE: On MacOS** the pre-commit hooks are currently broken. There are workarounds involving switching to unstable nightly Rust and components. +Commits are automatically validated. +If a check fails, the commit is aborted and an error message is displayed. +Apply the required changes and retry the commit. ### clippy ```shell -cargo clippy --all-targets --all-features +cargo clippy --workspace --all-targets --all-features ``` -The `msrv` key in the clippy configuration file `clippy.toml` is used to disable -lints pertaining to newer features by specifying the minimum supported Rust -version (MSRV). +**NOTE: On MacOS** avoid using the `--all-features` option as it currently +triggers compilation errors (see ). ### rustfmt