Skip to content

Document environment variables in cargo help #4079

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
devurandom opened this issue May 21, 2017 · 2 comments
Closed

Document environment variables in cargo help #4079

devurandom opened this issue May 21, 2017 · 2 comments
Labels
A-documenting-cargo-itself Area: Cargo's documentation

Comments

@devurandom
Copy link

According to the Cargo docs on crates.io, cargo build will be influenced by e.g. CARGO_TARGET_DIR, but cargo help does not document this.

Furthermore, the Cargo guide does not link to the documentation of the environment variables, which makes this feature rather hard to find.

@alexcrichton alexcrichton added the A-documenting-cargo-itself Area: Cargo's documentation label May 21, 2017
@dwijnand
Copy link
Member

Well the later half is no longer true. The Cargo guide now presents a sidebar TOC where the documentation for the environment variable is reachable.

@ehuss
Copy link
Contributor

ehuss commented Dec 1, 2019

The documentation has been updated along the way to include more hints about environment variables. The --target flag at https://doc.rust-lang.org/cargo/commands/cargo-build.html mentions it. The cargo-build man page also has an Environment section which links to the reference. Embedding more detailed help in the built-in help output is tracked in #6104, so I'm going to close in favor of that for future improvements.

@ehuss ehuss closed this as completed Dec 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
Projects
None yet
Development

No branches or pull requests

4 participants