Skip to content

Commit bd0fb9f

Browse files
committed
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.
1 parent ab71ba9 commit bd0fb9f

File tree

6 files changed

+76
-0
lines changed

6 files changed

+76
-0
lines changed

src/doc/src/SUMMARY.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,10 @@
9292
* [cargo package](commands/cargo-package.md)
9393
* [cargo publish](commands/cargo-publish.md)
9494
* [cargo yank](commands/cargo-yank.md)
95+
* [External Commands](commands/external-commands.md)
96+
* [cargo clippy](commands/cargo-clippy.md)
97+
* [cargo fmt](commands/cargo-fmt.md)
98+
* [cargo miri](commands/cargo-miri.md)
9599

96100
* [FAQ](faq.md)
97101
* [Appendix: Glossary](appendix/glossary.md)
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# cargo-clippy(1)
2+
3+
## NAME
4+
5+
cargo-miri --- Checks a package to catch common mistakes and improve your Rust code
6+
7+
## DESCRIPTION
8+
9+
This is an external command distributed with the Rust toolchain as an optional component.
10+
It is not built into Cargo, and may require additional installation.
11+
12+
For information about usage and installation,
13+
see [Clippy Documentation](../../clippy/).
14+
15+
## SEE ALSO
16+
17+
[cargo(1)](cargo.md),
18+
[cargo-fix(1)](cargo-fix.md),
19+
[cargo-fmt(1)](cargo-fmt.md),
20+
[Custom subcommands](../reference/external-tools.md#custom-subcommands)

src/doc/src/commands/cargo-fmt.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# cargo-fmt(1)
2+
3+
## NAME
4+
5+
carog-fmt --- Formats all bin and lib files of the current crate using rustfmt
6+
7+
## DESCRIPTION
8+
9+
This is an external command distributed with the Rust toolchain as an optional component.
10+
It is not built into Cargo, and may require additional installation.
11+
12+
For information about usage and installation,
13+
see <https://github.com/rust-lang/rustfmt>.
14+
15+
## SEE ALSO
16+
17+
[cargo(1)](cargo.md),
18+
[cargo-fix(1)](cargo-fix.md),
19+
[cargo-clippy(1)](cargo-clippy.md),
20+
[Custom subcommands](../reference/external-tools.md#custom-subcommands)

src/doc/src/commands/cargo-miri.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# cargo-miri(1)
2+
3+
## NAME
4+
5+
cargo-miri --- Runs binary crates and tests in Miri
6+
7+
## DESCRIPTION
8+
9+
This is an external command distributed with the Rust toolchain as an optional component.
10+
It is not built into Cargo, and may require additional installation.
11+
12+
For information about usage and installation,
13+
see <https://github.com/rust-lang/miri>.
14+
15+
## SEE ALSO
16+
17+
[cargo(1)](cargo.md),
18+
[cargo-run(1)](cargo-run.md),
19+
[cargo-test(1)](cargo-test.md),
20+
[Custom subcommands](../reference/external-tools.md#custom-subcommands)
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# External Commands
2+
3+
This page maintains a list of [external commands] distributed with the Rust
4+
toolchain as optional components.
5+
They are not built into Cargo, and may require additional installation.
6+
7+
* [cargo clippy](cargo-clippy.md)
8+
* [cargo fmt](cargo-fmt.md)
9+
* [cargo miri](cargo-miri.md)
10+
11+
[external commands]: ../reference/external-tools.md#custom-subcommands

src/doc/src/commands/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
* [Manifest Commands](manifest-commands.md)
55
* [Package Commands](package-commands.md)
66
* [Publishing Commands](publishing-commands.md)
7+
* [External Commands](external-commands.md)

0 commit comments

Comments
 (0)