-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto merge of #14669 - weihanglo:docs-external-commands, r=epage
docs: document official external commands ### What does this PR try to resolve? This documents external commands that are distributed along with the Rust toolchain, including * `cargo-clippy` * `cargo-fmt` * `cargo-miri` The purpose of this is increasing the visibility of these tools, and redirecting people to the correct place to discuss and learn them. Fixes #14640
- Loading branch information
Showing
6 changed files
with
80 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# cargo-clippy(1) | ||
|
||
## NAME | ||
|
||
cargo-miri --- Checks a package to catch common mistakes and improve your Rust code | ||
|
||
## DESCRIPTION | ||
|
||
This is an external command distributed with the Rust toolchain as an optional component. | ||
It is not built into Cargo, and may require additional installation. | ||
|
||
For information about usage and installation, | ||
see [Clippy Documentation](../../clippy/index.html). | ||
|
||
## SEE ALSO | ||
|
||
[cargo(1)](cargo.md), | ||
[cargo-fix(1)](cargo-fix.md), | ||
[cargo-fmt(1)](cargo-fmt.md), | ||
[Custom subcommands](../reference/external-tools.md#custom-subcommands) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# cargo-fmt(1) | ||
|
||
## NAME | ||
|
||
carog-fmt --- Formats all bin and lib files of the current crate using rustfmt | ||
|
||
## DESCRIPTION | ||
|
||
This is an external command distributed with the Rust toolchain as an optional component. | ||
It is not built into Cargo, and may require additional installation. | ||
|
||
For information about usage and installation, | ||
see <https://github.com/rust-lang/rustfmt>. | ||
|
||
## SEE ALSO | ||
|
||
[cargo(1)](cargo.md), | ||
[cargo-fix(1)](cargo-fix.md), | ||
[cargo-clippy(1)](cargo-clippy.md), | ||
[Custom subcommands](../reference/external-tools.md#custom-subcommands) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# cargo-miri(1) | ||
|
||
## NAME | ||
|
||
cargo-miri --- Runs binary crates and tests in Miri | ||
|
||
## DESCRIPTION | ||
|
||
This is an external command distributed with the Rust toolchain as an optional component. | ||
It is not built into Cargo, and may require additional installation. | ||
|
||
This command is only available on the [nightly](https://doc.rust-lang.org/book/appendix-07-nightly-rust.html) channel. | ||
|
||
For information about usage and installation, | ||
see <https://github.com/rust-lang/miri>. | ||
|
||
## SEE ALSO | ||
|
||
[cargo(1)](cargo.md), | ||
[cargo-run(1)](cargo-run.md), | ||
[cargo-test(1)](cargo-test.md), | ||
[Custom subcommands](../reference/external-tools.md#custom-subcommands) |