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.

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

Jump to bottom

Improve CARGO_ENCODED_RUSTFLAGS documentation #10555

Closed
ehuss opened this issue Apr 11, 2022 · 1 comment · Fixed by #10633
Closed

Improve CARGO_ENCODED_RUSTFLAGS documentation #10555

ehuss opened this issue Apr 11, 2022 · 1 comment · Fixed by #10633
Assignees
@Rustin170506
Labels
A-documenting-cargo-itself Area: Cargo's documentation E-easy Experience: Easy

Comments

@ehuss
Copy link
Contributor

ehuss commented Apr 11, 2022 •
edited by rustbot
Loading

CARGO_ENCODED_RUSTFLAGS and CARGO_ENCODED_RUSTDOCFLAGS were added in #9601. The current documentation may be a little confusing. I think the following changes could help:

  • In Environment variables Cargo reads, include both environment variables as dedicated entries to the list.
  • I would also reword the existing "for a more robust encoding of multiple arguments, set CARGO_ENCODED_RUSTFLAGS instead with arguments separated by 0x1f (ASCII Unit Separator)." to be "for a more robust encoding of multiple arguments, see CARGO_ENCODED_RUSTFLAGS".
  • Update build.rustflags and build.rustdocflags to include the new environment variables, and to document the precedence behavior.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Rustin170506 Rustin170506

Labels
A-documenting-cargo-itself Area: Cargo's documentation E-easy Experience: Easy
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve CARGO_ENCODED_RUSTFLAGS and CARGO_ENCODED_RUSTDOCFLAGS variables docs Rustin170506/cargo
2 participants
@ehuss @Rustin170506