From a4e3cfe580a439d2ae031ab6a8d17cfd36e4bb07 Mon Sep 17 00:00:00 2001 From: Weihang Lo Date: Tue, 23 Dec 2025 11:30:05 -0500 Subject: [PATCH] docs(report): move `cargo report` to its own subsection --- .ignore | 1 + src/doc/man/cargo.md | 5 +++++ src/doc/man/generated_txt/cargo.txt | 4 ++++ src/doc/src/SUMMARY.md | 3 ++- src/doc/src/commands/build-commands.md | 1 - src/doc/src/commands/cargo.md | 5 +++++ src/doc/src/commands/index.md | 1 + src/doc/src/commands/report-commands.md | 3 +++ src/etc/man/cargo.1 | 4 ++++ 9 files changed, 25 insertions(+), 2 deletions(-) create mode 100644 src/doc/src/commands/report-commands.md diff --git a/.ignore b/.ignore index e51dabef3..716739c37 100644 --- a/.ignore +++ b/.ignore @@ -13,6 +13,7 @@ src/etc/man !src/doc/src/commands/manifest-commands.md !src/doc/src/commands/package-commands.md !src/doc/src/commands/publishing-commands.md +!src/doc/src/commands/report-commands.md # Snapshots of HTML reports and log files are just too large tests/testsuite/**/*.jsonl diff --git a/src/doc/man/cargo.md b/src/doc/man/cargo.md index 21bfe620a..5afcb3ffc 100644 --- a/src/doc/man/cargo.md +++ b/src/doc/man/cargo.md @@ -123,6 +123,11 @@ available at . {{man "cargo-yank" 1}}\     Remove a pushed crate from the index. +### Report Commands + +{{man "cargo-report" 1}}\ +    Generate and display various kinds of reports. + ### General Commands {{man "cargo-help" 1}}\ diff --git a/src/doc/man/generated_txt/cargo.txt b/src/doc/man/generated_txt/cargo.txt index b2e359fa5..d93e645a0 100644 --- a/src/doc/man/generated_txt/cargo.txt +++ b/src/doc/man/generated_txt/cargo.txt @@ -117,6 +117,10 @@ COMMANDS cargo-yank(1)     Remove a pushed crate from the index. + Report Commands + cargo-report(1) +     Generate and display various kinds of reports. + General Commands cargo-help(1)     Display help information about Cargo. diff --git a/src/doc/src/SUMMARY.md b/src/doc/src/SUMMARY.md index 40f6d4a5e..69527709c 100644 --- a/src/doc/src/SUMMARY.md +++ b/src/doc/src/SUMMARY.md @@ -66,7 +66,6 @@ * [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) @@ -95,6 +94,8 @@ * [cargo package](commands/cargo-package.md) * [cargo publish](commands/cargo-publish.md) * [cargo yank](commands/cargo-yank.md) + * [Report Commands](commands/report-commands.md) + * [cargo report](commands/cargo-report.md) * [Deprecated and Removed](commands/deprecated-and-removed.md) * [FAQ](faq.md) diff --git a/src/doc/src/commands/build-commands.md b/src/doc/src/commands/build-commands.md index f49f1916d..2e86635c5 100644 --- a/src/doc/src/commands/build-commands.md +++ b/src/doc/src/commands/build-commands.md @@ -9,7 +9,6 @@ * [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) diff --git a/src/doc/src/commands/cargo.md b/src/doc/src/commands/cargo.md index 03676e249..2424d4039 100644 --- a/src/doc/src/commands/cargo.md +++ b/src/doc/src/commands/cargo.md @@ -123,6 +123,11 @@ available at . [cargo-yank(1)](cargo-yank.html)\     Remove a pushed crate from the index. +### Report Commands + +[cargo-report(1)](cargo-report.html)\ +    Generate and display various kinds of reports. + ### General Commands [cargo-help(1)](cargo-help.html)\ diff --git a/src/doc/src/commands/index.md b/src/doc/src/commands/index.md index 8de601a61..5e636823c 100644 --- a/src/doc/src/commands/index.md +++ b/src/doc/src/commands/index.md @@ -4,4 +4,5 @@ * [Manifest Commands](manifest-commands.md) * [Package Commands](package-commands.md) * [Publishing Commands](publishing-commands.md) +* [Report Commands](report-commands.md) * [Deprecated and Removed](deprecated-and-removed.md) diff --git a/src/doc/src/commands/report-commands.md b/src/doc/src/commands/report-commands.md new file mode 100644 index 000000000..6e97cb65d --- /dev/null +++ b/src/doc/src/commands/report-commands.md @@ -0,0 +1,3 @@ +# Report Commands + +* [cargo report](cargo-report.md) diff --git a/src/etc/man/cargo.1 b/src/etc/man/cargo.1 index 80c8682a6..4d3952714 100644 --- a/src/etc/man/cargo.1 +++ b/src/etc/man/cargo.1 @@ -147,6 +147,10 @@ available at \&. \fBcargo\-yank\fR(1) .br \ \ \ \ Remove a pushed crate from the index. +.SS "Report Commands" +\fBcargo\-report\fR(1) +.br +\ \ \ \ Generate and display various kinds of reports. .SS "General Commands" \fBcargo\-help\fR(1) .br