diff --git a/README.md b/README.md index 83570e7..741cc54 100644 --- a/README.md +++ b/README.md @@ -14,20 +14,19 @@ For minimizing an internal compiler error on a normal cargo project, `cargo mini Usage: cargo minimize [OPTIONS] [PATH] Arguments: - [PATH] The directory/file of the code to be minimited [default: src] + [PATH] The directory/file of the code to be minimized [default: src] Options: - --cargo-args Additional arguments to pass to cargo, seperated by whitespace + --cargo-args Additional arguments to pass to cargo, separated by whitespace --no-color To disable colored output --rustc This option bypasses cargo and uses rustc directly. Only works when a single file is passed as an argument - --no-verify Skips testing whether the regression reproduces and just does the most aggressive minimization. Mostly useful for testing an demonstration purposes - --verify-fn A Rust closure returning a bool that checks whether a regression reproduces. Example: `--verify_fn='|output| output.contains("internal compiler error")'` + --no-verify Skips testing whether the regression reproduces and just does the most aggressive minimization. Mostly useful for testing and demonstration purposes + --verify-fn A Rust closure returning a bool that checks whether a regression reproduces. Example: `--verify-fn='|output| output.contains("internal compiler error")'` --env 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 --script-path NOTE: This is currently broken. A path to a script that is run to check whether code reproduces. When it exits with code 0, the problem reproduces -h, --help Print help information - ``` - +``` ## What it does diff --git a/src/lib.rs b/src/lib.rs index 4980850..c98512d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -31,7 +31,7 @@ pub enum Cargo { #[derive(clap::Args, Debug)] pub struct Options { - /// Additional arguments to pass to cargo, seperated by whitespace. + /// Additional arguments to pass to cargo, separated by whitespace. #[arg(long)] pub cargo_args: Option, @@ -44,12 +44,12 @@ pub struct Options { pub rustc: bool, /// Skips testing whether the regression reproduces and just does the most aggressive minimization. Mostly useful - /// for testing an demonstration purposes. + /// for testing and demonstration purposes. #[arg(long)] pub no_verify: bool, /// A Rust closure returning a bool that checks whether a regression reproduces. - /// Example: `--verify_fn='|output| output.contains("internal compiler error")'` + /// Example: `--verify-fn='|output| output.contains("internal compiler error")'` #[arg(long)] pub verify_fn: Option, @@ -62,7 +62,7 @@ pub struct Options { #[arg(long)] pub project_dir: Option, - /// The directory/file of the code to be minimited. + /// The directory/file of the code to be minimized. #[arg(default_value = "src")] pub path: PathBuf,