prusti-dev icon indicating copy to clipboard operation
prusti-dev copied to clipboard

Incorrect help message for `cargo-prusti`

Open Patrick-6 opened this issue 2 years ago • 0 comments

Running cargo-prusti --help will return the help message for cargo check:

Check a local package and all of its dependencies for errors

Usage: cargo check [OPTIONS]

Options:
    -q, --quiet               Do not print cargo log messages
    -p, --package [<SPEC>]    Package(s) to check
    --workspace               Check all packages in the workspace
    --exclude <SPEC>          Exclude packages from the check
    -v, --verbose...          Use verbose output (-vv very verbose/build.rs output)
    --all                     Alias for --workspace (deprecated)
    --color <WHEN>            Coloring: auto, always, never
    -j, --jobs <N>            Number of parallel jobs, defaults to # of CPUs
    --keep-going              Do not abort the build as soon as there is an error (unstable)
    --frozen                  Require Cargo.lock and cache are up to date
    --lib                     Check only this package's library
    --bin [<NAME>]            Check only the specified binary
    --locked                  Require Cargo.lock is up to date
    --bins                    Check all binaries
    --offline                 Run without accessing the network
    --config <KEY=VALUE>      Override a configuration value
    --example [<NAME>]        Check only the specified example
    --examples                Check all examples
    -Z <FLAG>                 Unstable (nightly-only) flags to Cargo, see 'cargo -Z help' for details
    --test [<NAME>]           Check only the specified test target
    --tests                   Check all tests
    --bench [<NAME>]          Check only the specified bench target
    --benches                 Check all benches
    --all-targets             Check all targets
    --release                 Check artifacts in release mode, with optimizations
    --profile <PROFILE-NAME>  Check artifacts with the specified profile
    -F, --features <FEATURES> Space or comma separated list of features to activate
    --all-features            Activate all available features
    --no-default-features     Do not activate the `default` feature
    --target <TRIPLE>         Check for the target triple
    --target-dir <DIRECTORY>  Directory for all generated artifacts
    --manifest-path <PATH>    Path to Cargo.toml
    --ignore-rust-version     Ignore `rust-version` specification in packages
    --message-format <FMT>    Error format
    --unit-graph              Output build graph in JSON (unstable)
    --future-incompat-report  Outputs a future incompatibility report at the end of the build
    --timings[=<FMTS>]        Timing output formats (unstable) (comma separated): html, json

Run `cargo help check` for more detailed information.

Adding a link to the Prusti user guide might also be helpful here.

Another command that could be useful is cargo-prusti --version to get the version number of the currently installed version of Prusti, similar to cargo clippy --version.

Patrick-6 avatar Jun 15 '23 09:06 Patrick-6