mirror of
https://github.com/rust-lang/cargo.git
synced 2025-09-25 11:14:46 +00:00
docs: document official external commands
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.
This commit is contained in:
parent
ab71ba9b5e
commit
caf44d43dc
@ -59,14 +59,17 @@
|
|||||||
* [cargo build](commands/cargo-build.md)
|
* [cargo build](commands/cargo-build.md)
|
||||||
* [cargo check](commands/cargo-check.md)
|
* [cargo check](commands/cargo-check.md)
|
||||||
* [cargo clean](commands/cargo-clean.md)
|
* [cargo clean](commands/cargo-clean.md)
|
||||||
|
* [cargo clippy](commands/cargo-clippy.md)
|
||||||
* [cargo doc](commands/cargo-doc.md)
|
* [cargo doc](commands/cargo-doc.md)
|
||||||
* [cargo fetch](commands/cargo-fetch.md)
|
* [cargo fetch](commands/cargo-fetch.md)
|
||||||
* [cargo fix](commands/cargo-fix.md)
|
* [cargo fix](commands/cargo-fix.md)
|
||||||
|
* [cargo fmt](commands/cargo-fmt.md)
|
||||||
|
* [cargo miri](commands/cargo-miri.md)
|
||||||
|
* [cargo report](commands/cargo-report.md)
|
||||||
* [cargo run](commands/cargo-run.md)
|
* [cargo run](commands/cargo-run.md)
|
||||||
* [cargo rustc](commands/cargo-rustc.md)
|
* [cargo rustc](commands/cargo-rustc.md)
|
||||||
* [cargo rustdoc](commands/cargo-rustdoc.md)
|
* [cargo rustdoc](commands/cargo-rustdoc.md)
|
||||||
* [cargo test](commands/cargo-test.md)
|
* [cargo test](commands/cargo-test.md)
|
||||||
* [cargo report](commands/cargo-report.md)
|
|
||||||
* [Manifest Commands](commands/manifest-commands.md)
|
* [Manifest Commands](commands/manifest-commands.md)
|
||||||
* [cargo add](commands/cargo-add.md)
|
* [cargo add](commands/cargo-add.md)
|
||||||
* [cargo generate-lockfile](commands/cargo-generate-lockfile.md)
|
* [cargo generate-lockfile](commands/cargo-generate-lockfile.md)
|
||||||
|
@ -3,11 +3,14 @@
|
|||||||
* [cargo build](cargo-build.md)
|
* [cargo build](cargo-build.md)
|
||||||
* [cargo check](cargo-check.md)
|
* [cargo check](cargo-check.md)
|
||||||
* [cargo clean](cargo-clean.md)
|
* [cargo clean](cargo-clean.md)
|
||||||
|
* [cargo clippy](cargo-clippy.md)
|
||||||
* [cargo doc](cargo-doc.md)
|
* [cargo doc](cargo-doc.md)
|
||||||
* [cargo fetch](cargo-fetch.md)
|
* [cargo fetch](cargo-fetch.md)
|
||||||
* [cargo fix](cargo-fix.md)
|
* [cargo fix](cargo-fix.md)
|
||||||
|
* [cargo fmt](cargo-fmt.md)
|
||||||
|
* [cargo miri](cargo-miri.md)
|
||||||
|
* [cargo report](cargo-report.md)
|
||||||
* [cargo run](cargo-run.md)
|
* [cargo run](cargo-run.md)
|
||||||
* [cargo rustc](cargo-rustc.md)
|
* [cargo rustc](cargo-rustc.md)
|
||||||
* [cargo rustdoc](cargo-rustdoc.md)
|
* [cargo rustdoc](cargo-rustdoc.md)
|
||||||
* [cargo test](cargo-test.md)
|
* [cargo test](cargo-test.md)
|
||||||
* [cargo report](cargo-report.md)
|
|
||||||
|
20
src/doc/src/commands/cargo-clippy.md
Normal file
20
src/doc/src/commands/cargo-clippy.md
Normal file
@ -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)
|
20
src/doc/src/commands/cargo-fmt.md
Normal file
20
src/doc/src/commands/cargo-fmt.md
Normal file
@ -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)
|
22
src/doc/src/commands/cargo-miri.md
Normal file
22
src/doc/src/commands/cargo-miri.md
Normal file
@ -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)
|
Loading…
x
Reference in New Issue
Block a user