Skip to content

fix(clean): clarify why 'cargo clean' default != 'release' artifact set (#17129) #17132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Dodothereal wants to merge 5 commits into
base: master
Choose a base branch
from
Open

fix(clean): clarify why 'cargo clean' default != 'release' artifact set (#17129) #17132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9041b53
fix(clean): clarify why 'cargo clean' default != 'release' artifact s…
Dodothereal Jun 23, 2026
2e4ccc4
docs(clean): align --release/--profile long help with the revised sho…
Dodothereal Jun 24, 2026
6b8db79
test(clean): refresh --help snapshot for revised --release/--profile …
Dodothereal Jun 24, 2026
5ffb034
docs(clean): drop redundant parenthetical after LeandroVandari review
Dodothereal Jun 24, 2026
d69feb4
test(man): regenerate cargo-clean.1 to match trimmed long help
Dodothereal Jun 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/bin/cargo/commands/clean.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ pub fn cli() -> Command {
flag("workspace", "Clean artifacts of the workspace members")
.help_heading(heading::PACKAGE_SELECTION),
)
.arg_release("Whether or not to clean release artifacts")
.arg_profile("Clean artifacts of the specified profile")
.arg_release("Clean only release artifacts")
.arg_profile("Clean only artifacts of the specified profile")
.arg_target_triple("Target triple to clean output for")
.arg_target_dir()
.arg_manifest_path()
Expand Down
4 changes: 2 additions & 2 deletions src/doc/man/cargo-clean.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ the target directory.
{{/option}}

{{#option "`--release`" }}
Remove all artifacts in the `release` directory.
Remove artifacts in the `release` directory only.
{{/option}}

{{#option "`--profile` _name_" }}
Remove all artifacts in the directory with the given profile name.
Remove artifacts only in the directory with the given profile name.
{{/option}}

{{> options-target-dir }}
Expand Down
4 changes: 2 additions & 2 deletions src/doc/man/generated_txt/cargo-clean.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ OPTIONS
in the target directory.

--release
Remove all artifacts in the release directory.
Remove artifacts in the release directory only.

--profile name
Remove all artifacts in the directory with the given profile name.
Remove artifacts only in the directory with the given profile name.

--target-dir directory
Directory for all generated artifacts and intermediate files. May
Expand Down
4 changes: 2 additions & 2 deletions src/doc/src/commands/cargo-clean.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,12 @@ the target directory.</p>


<dt class="option-term" id="option-cargo-clean---release"><a class="option-anchor" href="#option-cargo-clean---release"><code>--release</code></a></dt>
<dd class="option-desc"><p>Remove all artifacts in the <code>release</code> directory.</p>
<dd class="option-desc"><p>Remove artifacts in the <code>release</code> directory only.</p>
</dd>


<dt class="option-term" id="option-cargo-clean---profile"><a class="option-anchor" href="#option-cargo-clean---profile"><code>--profile</code> <em>name</em></a></dt>
<dd class="option-desc"><p>Remove all artifacts in the directory with the given profile name.</p>
<dd class="option-desc"><p>Remove artifacts only in the directory with the given profile name.</p>
</dd>


Expand Down
4 changes: 2 additions & 2 deletions src/etc/man/cargo-clean.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ the target directory.
.sp
\fB\-\-release\fR
.RS 4
Remove all artifacts in the \fBrelease\fR directory.
Remove artifacts in the \fBrelease\fR directory only.
.RE
.sp
\fB\-\-profile\fR \fIname\fR
.RS 4
Remove all artifacts in the directory with the given profile name.
Remove artifacts only in the directory with the given profile name.
Comment on lines +47 to +52

@0xPoe 0xPoe Jul 14, 2026 •
edited by rustbot
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why we need to have two styles here. Maybe we should unify the only places.

View changes since the review

.RE
.sp
\fB\-\-target\-dir\fR \fIdirectory\fR
Expand Down
4 changes: 2 additions & 2 deletions tests/testsuite/cargo_clean/help/stdout.term.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.