Skip to content

document environment variables in the unstable book #141523

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
Closed
jyn514 opened this issue May 24, 2025 · 0 comments · Fixed by #141526
Closed

document environment variables in the unstable book #141523

jyn514 opened this issue May 24, 2025 · 0 comments · Fixed by #141526
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.

Comments

@jyn514
Copy link
Member

jyn514 commented May 24, 2025

Location

https://doc.rust-lang.org/nightly/unstable-book/

Summary

right now, https://doc.rust-lang.org/nightly/unstable-book/compiler-flags.html documents unstable compiler flags. but to my knowledge, there is no equivalent place to document compiler environment variables (such as RUSTC_ICE). currently we hack in RUSTC_BOOTSTRAP and RUSTC_OVERRIDE_VERSION_STRING to the flags section. i think it would be nice to have a dedicated section, encouraging people to document the env vars.
@jyn514 jyn514 added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label May 24, 2025
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label May 24, 2025
@jyn514 jyn514 mentioned this issue May 25, 2025
Merged
@jieyouxu jieyouxu added T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels May 26, 2025
@bors bors closed this as completed in d5a26c5 May 26, 2025
rust-timer added a commit that referenced this issue May 26, 2025
@rust-timer
Unrolled build for #141526
e2b71fb 
Rollup merge of #141526 - jyn514:env-vars, r=petrochenkov

add a dedicated section for compiler environment variables in the unstable book

rendered: ![image](https://github.com/user-attachments/assets/dcb6e2a3-2e2d-43bb-8f45-79715705bf45)

fixes #141523
github-actions bot pushed a commit to rust-lang/miri that referenced this issue May 27, 2025
@jieyouxu
Rollup merge of #141526 - jyn514:env-vars, r=petrochenkov
b2521d2 
add a dedicated section for compiler environment variables in the unstable book

rendered: ![image](https://github.com/user-attachments/assets/dcb6e2a3-2e2d-43bb-8f45-79715705bf45)

fixes rust-lang/rust#141523
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

add a dedicated section for compiler environment variables in the unstable book jyn514/rust
3 participants
@jyn514 @jieyouxu @rustbot