Skip to content
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.

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

Built-in alias cargo rm need its spot in configuration doc #11348

Closed
weihanglo opened this issue Nov 7, 2022 · 0 comments · Fixed by #11351
Closed

Built-in alias cargo rm need its spot in configuration doc #11348

weihanglo opened this issue Nov 7, 2022 · 0 comments · Fixed by #11351
Labels
A-aliases Area: command aliases A-documenting-cargo-itself Area: Cargo's documentation C-bug Category: bug Command-remove E-easy Experience: Easy

Comments

@weihanglo
Copy link
Member

Problem

cargo rm, an alias to cargo remove, should be mentioned in chapter Configuration in The Cargo Book.

diff --git a/src/doc/src/reference/config.md b/src/doc/src/reference/config.md
index f60c185e9..54a51aeb9 100644
--- a/src/doc/src/reference/config.md
+++ b/src/doc/src/reference/config.md
@@ -348,6 +348,7 @@ c = "check"
 d = "doc"
 t = "test"
 r = "run"
+rm = "remove"

Steps

No response

Possible Solution(s)

No response

Notes

We may or may not want to mention the alias command in each manpage of all subcommands. Anyhow, that ought to be a separate issue. At this moment, the user can run cargo --list | grep 'alias:' to find all aliases.

Version

cargo 1.67.0-nightly (9286a1beb 2022-11-04)
release: 1.67.0-nightly
commit-hash: 9286a1beba5b28b115bad67de2ae91fb1c61eb0b
commit-date: 2022-11-04
@weihanglo weihanglo added C-bug Category: bug A-documenting-cargo-itself Area: Cargo's documentation E-easy Experience: Easy A-aliases Area: command aliases Command-remove labels Nov 7, 2022
@bors bors closed this as completed in 5ccea51 Nov 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-aliases Area: command aliases A-documenting-cargo-itself Area: Cargo's documentation C-bug Category: bug Command-remove E-easy Experience: Easy
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant