Skip to content

Commit

Permalink
Auto merge of #14669 - weihanglo:docs-external-commands, r=epage
Browse files Browse the repository at this point in the history
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
bors committed Oct 11, 2024
2 parents 1e5bad3 + 21dacad commit e8adba9
Show file tree
Hide file tree
Showing 6 changed files with 80 additions and 3 deletions.
11 changes: 10 additions & 1 deletion .ignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,14 @@
#
# The goal is to help people find the right file to edit
src/doc/man/generated_txt
src/doc/src/commands
src/doc/src/commands/*
src/etc/man
!src/doc/src/commands/build-commands.md
!src/doc/src/commands/cargo-clippy.md
!src/doc/src/commands/cargo-fmt.md
!src/doc/src/commands/cargo-miri.md
!src/doc/src/commands/general-commands.md
!src/doc/src/commands/index.md
!src/doc/src/commands/manifest-commands.md
!src/doc/src/commands/package-commands.md
!src/doc/src/commands/publishg-commands.md
5 changes: 4 additions & 1 deletion src/doc/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,17 @@
* [cargo build](commands/cargo-build.md)
* [cargo check](commands/cargo-check.md)
* [cargo clean](commands/cargo-clean.md)
* [cargo clippy](commands/cargo-clippy.md)
* [cargo doc](commands/cargo-doc.md)
* [cargo fetch](commands/cargo-fetch.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 rustc](commands/cargo-rustc.md)
* [cargo rustdoc](commands/cargo-rustdoc.md)
* [cargo test](commands/cargo-test.md)
* [cargo report](commands/cargo-report.md)
* [Manifest Commands](commands/manifest-commands.md)
* [cargo add](commands/cargo-add.md)
* [cargo generate-lockfile](commands/cargo-generate-lockfile.md)
Expand Down
5 changes: 4 additions & 1 deletion src/doc/src/commands/build-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,14 @@
* [cargo build](cargo-build.md)
* [cargo check](cargo-check.md)
* [cargo clean](cargo-clean.md)
* [cargo clippy](cargo-clippy.md)
* [cargo doc](cargo-doc.md)
* [cargo fetch](cargo-fetch.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 rustc](cargo-rustc.md)
* [cargo rustdoc](cargo-rustdoc.md)
* [cargo test](cargo-test.md)
* [cargo report](cargo-report.md)
20 changes: 20 additions & 0 deletions src/doc/src/commands/cargo-clippy.md
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)
20 changes: 20 additions & 0 deletions src/doc/src/commands/cargo-fmt.md
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)
22 changes: 22 additions & 0 deletions src/doc/src/commands/cargo-miri.md
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)

0 comments on commit e8adba9

Please sign in to comment.