From 2f1eaecad727e67aed1210ce8a294497ffa18282 Mon Sep 17 00:00:00 2001 From: Noratrieb <48135649+Noratrieb@users.noreply.github.com> Date: Sun, 20 Apr 2025 15:59:14 +0200 Subject: [PATCH] update docs --- README.md | 8 +++++++- src/lib.rs | 1 + 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ac0e04d..bff7122 100644 --- a/README.md +++ b/README.md @@ -37,12 +37,18 @@ Options: Additional environment variables to pass to cargo/rustc. Example: `--env NAME=VALUE --env ANOTHER_NAME=VALUE` --project-dir The working directory where cargo/rustc are invoked in. By default, this is the current working directory + --passes + A comma-seperated list of passes that should be enabled. By default, all passes are enabled. If a pass is prefixed with `no-`, it will be disabled --script-path A path to a script that is run to check whether code reproduces. When it exits with code 0, the problem reproduces. If `--script-path-lints` isn't set, this script is also run to get lints. For lints, the `MINIMIZE_LINTS` environment variable will be set to `1`. The first line of the lint stdout or stderr can be `minimize-fmt-rustc` or `minimize-fmt-cargo` to show whether the rustc or wrapper cargo lint format and which output stream is used. Defaults to cargo and stdout --script-path-lints A path to a script that is run to get lints. The first line of stdout or stderr must be `minimize-fmt-rustc` or `minimize-fmt-cargo` to show whether the rustc or wrapper cargo lint format and which output stream is used. Defaults to cargo and stdout + --ignore-file + Do not touch the following files + --bisect-delete-imports + Remove individual use statements manually, instead of relying on rustc lints output -h, --help - Print help information + Print help ``` Note: You can safely press `Ctrl-C` when running cargo-minimize. It will rollback the current minimization attempt and give you the latest known-reproducing state. diff --git a/src/lib.rs b/src/lib.rs index a873772..2b10da9 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -83,6 +83,7 @@ pub struct Options { pub path: PathBuf, /// A comma-seperated list of passes that should be enabled. By default, all passes are enabled. + /// If a pass is prefixed with `no-`, it will be disabled. #[arg(long)] pub passes: Option,