mirror of
https://github.com/Noratrieb/cargo-minimize.git
synced 2026-01-16 17:25:03 +01:00
Fix typos
This commit is contained in:
parent
63c49b8dfa
commit
8fc0693cc3
2 changed files with 9 additions and 10 deletions
|
|
@ -14,21 +14,20 @@ For minimizing an internal compiler error on a normal cargo project, `cargo mini
|
||||||
Usage: cargo minimize [OPTIONS] [PATH]
|
Usage: cargo minimize [OPTIONS] [PATH]
|
||||||
|
|
||||||
Arguments:
|
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:
|
Options:
|
||||||
--cargo-args <CARGO_ARGS> Additional arguments to pass to cargo, seperated by whitespace
|
--cargo-args <CARGO_ARGS> Additional arguments to pass to cargo, separated by whitespace
|
||||||
--no-color To disable colored output
|
--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
|
--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
|
--no-verify Skips testing whether the regression reproduces and just does the most aggressive minimization. Mostly useful for testing and demonstration purposes
|
||||||
--verify-fn <VERIFY_FN> A Rust closure returning a bool that checks whether a regression reproduces. Example: `--verify_fn='|output| output.contains("internal compiler error")'`
|
--verify-fn <VERIFY_FN> A Rust closure returning a bool that checks whether a regression reproduces. Example: `--verify-fn='|output| output.contains("internal compiler error")'`
|
||||||
--env <ENV> Additional environment variables to pass to cargo/rustc. Example: `--env NAME=VALUE --env ANOTHER_NAME=VALUE`
|
--env <ENV> Additional environment variables to pass to cargo/rustc. Example: `--env NAME=VALUE --env ANOTHER_NAME=VALUE`
|
||||||
--project-dir <PROJECT_DIR> The working directory where cargo/rustc are invoked in. By default, this is the current working directory
|
--project-dir <PROJECT_DIR> The working directory where cargo/rustc are invoked in. By default, this is the current working directory
|
||||||
--script-path <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
|
--script-path <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
|
-h, --help Print help information
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## What it does
|
## What it does
|
||||||
|
|
||||||
`cargo-minimize` is currently fairly simple. It does several passes over the source code. It treats each file in isolation.
|
`cargo-minimize` is currently fairly simple. It does several passes over the source code. It treats each file in isolation.
|
||||||
|
|
|
||||||
|
|
@ -31,7 +31,7 @@ pub enum Cargo {
|
||||||
|
|
||||||
#[derive(clap::Args, Debug)]
|
#[derive(clap::Args, Debug)]
|
||||||
pub struct Options {
|
pub struct Options {
|
||||||
/// Additional arguments to pass to cargo, seperated by whitespace.
|
/// Additional arguments to pass to cargo, separated by whitespace.
|
||||||
#[arg(long)]
|
#[arg(long)]
|
||||||
pub cargo_args: Option<String>,
|
pub cargo_args: Option<String>,
|
||||||
|
|
||||||
|
|
@ -44,12 +44,12 @@ pub struct Options {
|
||||||
pub rustc: bool,
|
pub rustc: bool,
|
||||||
|
|
||||||
/// Skips testing whether the regression reproduces and just does the most aggressive minimization. Mostly useful
|
/// 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)]
|
#[arg(long)]
|
||||||
pub no_verify: bool,
|
pub no_verify: bool,
|
||||||
|
|
||||||
/// A Rust closure returning a bool that checks whether a regression reproduces.
|
/// 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)]
|
#[arg(long)]
|
||||||
pub verify_fn: Option<RustFunction>,
|
pub verify_fn: Option<RustFunction>,
|
||||||
|
|
||||||
|
|
@ -62,7 +62,7 @@ pub struct Options {
|
||||||
#[arg(long)]
|
#[arg(long)]
|
||||||
pub project_dir: Option<PathBuf>,
|
pub project_dir: Option<PathBuf>,
|
||||||
|
|
||||||
/// The directory/file of the code to be minimited.
|
/// The directory/file of the code to be minimized.
|
||||||
#[arg(default_value = "src")]
|
#[arg(default_value = "src")]
|
||||||
pub path: PathBuf,
|
pub path: PathBuf,
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue