Skip to content

Aliases entirely undocumented #4391

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

Closed
Osspial opened this issue Aug 10, 2017 · 3 comments
Closed

Aliases entirely undocumented #4391

Osspial opened this issue Aug 10, 2017 · 3 comments
Labels
A-documenting-cargo-itself Area: Cargo's documentation C-enhancement Category: enhancement

Comments

@Osspial
Copy link

Osspial commented Aug 10, 2017

Cargo has built-in aliases for cargo build, cargo test and cargo run, in the forms of cargo b, cargo t and cargo r. However, these aliases seems to have gone unmentioned in all of cargo's documentation, and I can't find any mention of them on rust-lang.org, crates.io, or cargo's help command. This is admittedly pretty low-priority as far as documentation holes go, but these aliases should get some mention in cargo's help command if not elsewhere.

@alexcrichton alexcrichton added the A-documenting-cargo-itself Area: Cargo's documentation label Aug 10, 2017
@sfackler
Copy link
Member

They are documented down in the bottom of the example .cargo/config here, but it's not particularly obvious: http://doc.crates.io/config.html#configuration-keys

@dwijnand
Copy link
Member

Another URL is https://doc.rust-lang.org/cargo/reference/config.html#configuration-keys.

I (personally) don't have any specific ideas what should change, so maybe we can close this?

@dwijnand
Copy link
Member

dwijnand commented Feb 1, 2019

I'm going to close those on the basis that "entirely undocumented" isn't true.

But let us know if you have any suggestions on how to document them better.

@dwijnand dwijnand closed this as completed Feb 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documenting-cargo-itself Area: Cargo's documentation C-enhancement Category: enhancement
Projects
None yet
Development

No branches or pull requests

5 participants