Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename clippy-preview to clippy and stabilize it #7382

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions src/doc/man/cargo-clippy.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
= cargo-clippy(1)
:idprefix: cargo_clippy_
:doctype: manpage
:actionverb: Clippy

== NAME

cargo-clippy - Check the current package with clippy

== SYNOPSIS

`cargo clippy [_OPTIONS_]`

== DESCRIPTION

Check a local package and all of its local dependencies for common mistakes
with clippy.

== OPTIONS

yaahc marked this conversation as resolved.
Show resolved Hide resolved
=== Package Selection

include::options-packages.adoc[]

=== Target Selection

When no target selection options are given, `cargo clippy` will check all
binary and library targets of the selected packages. Binaries are skipped if
they have `required-features` that are missing.

include::options-targets.adoc[]

include::options-features.adoc[]

=== Compilation Options

include::options-target-triple.adoc[]

include::options-release.adoc[]

include::options-profile.adoc[]

=== Output Options

include::options-target-dir.adoc[]

=== Display Options

include::options-display.adoc[]

include::options-message-format.adoc[]

=== Manifest Options

include::options-manifest-path.adoc[]

include::options-locked.adoc[]

=== Common Options

include::options-common.adoc[]

=== Miscellaneous Options

include::options-jobs.adoc[]

include::section-profiles.adoc[]

include::section-environment.adoc[]

include::section-exit-status.adoc[]

== EXAMPLES

. Check the local package for common mistakes:

cargo clippy

. Check all targets, including unit tests:

cargo clippy --all-targets --profile=test

== SEE ALSO
man:cargo[1], man:cargo-build[1], man:cargo-check[1]
Loading