Add cargo --dry-run to the documentation.

rust-lang · Sep 20, 2023 · 655f75d · 655f75d
1 parent c204734
commit 655f75d
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/src/doc/man/cargo-clean.md b/src/doc/man/cargo-clean.md
@@ -36,6 +36,11 @@ multiple times. See {{man "cargo-pkgid" 1}} for the SPEC format.
 
 {{#options}}
 
+{{#option "`--dry-run`" }}
+Displays a summary of what would be deleted without deleting anything.
+Use with `--verbose` to display the actual files that would be deleted.
+{{/option}}
+
 {{#option "`--doc`" }}
 This option will cause `cargo clean` to remove only the `doc` directory in
 the target directory.

diff --git a/src/doc/man/generated_txt/cargo-clean.txt b/src/doc/man/generated_txt/cargo-clean.txt
@@ -22,6 +22,11 @@ OPTIONS
            multiple times. See cargo-pkgid(1) for the SPEC format.
 
    Clean Options
+       --dry-run
+           Displays a summary of what would be deleted without deleting
+           anything. Use with --verbose to display the actual files that would
+           be deleted.
+
        --doc
            This option will cause cargo clean to remove only the doc directory
            in the target directory.

diff --git a/src/doc/src/commands/cargo-clean.md b/src/doc/src/commands/cargo-clean.md
@@ -34,6 +34,11 @@ multiple times. See <a href="cargo-pkgid.html">cargo-pkgid(1)</a> for the SPEC f
 
 <dl>
 
+<dt class="option-term" id="option-cargo-clean---dry-run"><a class="option-anchor" href="#option-cargo-clean---dry-run"></a><code>--dry-run</code></dt>
+<dd class="option-desc">Displays a summary of what would be deleted without deleting anything.
+Use with <code>--verbose</code> to display the actual files that would be deleted.</dd>
+
+
 <dt class="option-term" id="option-cargo-clean---doc"><a class="option-anchor" href="#option-cargo-clean---doc"></a><code>--doc</code></dt>
 <dd class="option-desc">This option will cause <code>cargo clean</code> to remove only the <code>doc</code> directory in
 the target directory.</dd>

diff --git a/src/etc/man/cargo-clean.1 b/src/etc/man/cargo-clean.1
@@ -25,6 +25,12 @@ multiple times. See \fBcargo\-pkgid\fR(1) for the SPEC format.
 .RE
 .SS "Clean Options"
 .sp
+\fB\-\-dry\-run\fR
+.RS 4
+Displays a summary of what would be deleted without deleting anything.
+Use with \fB\-\-verbose\fR to display the actual files that would be deleted.
+.RE
+.sp
 \fB\-\-doc\fR
 .RS 4
 This option will cause \fBcargo clean\fR to remove only the \fBdoc\fR directory in