Undocumented environment variables?
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 22h 40m
- Merged PRs (30d)
- 46
Description
Problem you are trying to solve
https://rust-lang.github.io/rustup/environment-variables.html
https://rust-lang.github.io/rustup/dev-guide/tips-and-tricks.html
After reading the rustup code a little (https://github.com/rust-lang/rust-forge/issues/760), I found out that not all the environment variables it supports are documented. A quick search using grep -rniI -e "var(" -e "env\!(" -e "env(" -e "var_os(" revealed at least these:
- Particularly important because current doc directly advises using
RUSTUP_DIST_SERVERfor this, contrary to rust-lang/rustup@f08c4fe8026cb48582b01a27d4ff72cc51b5299d:
https://github.com/rust-lang/rustup/blob/edf5c22d478ecce60ae35e3d3a1ae5ff04c6bedb/doc/user-guide/src/environment-variables.md?plain=1#L17-L20
https://github.com/rust-lang/rustup/blob/edf5c22d478ecce60ae35e3d3a1ae5ff04c6bedb/src/config.rs#L274
https://github.com/rust-lang/rustup/blob/edf5c22d478ecce60ae35e3d3a1ae5ff04c6bedb/src/config.rs#L400
Solution you'd like
Describe all this somewhere and/or make a list of variables for internal use so as not to confuse people.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with doc/user-guide/src/environment-variables.md and compare its list with the environment-variable reads linked in src/cli/self_update/unix.rs, src/cli/self_update/windows.rs, src/cli/self_update.rs, src/dist/mod.rs, src/utils/utils.rs, src/config.rs, and src/toolchain.rs. Identify which variables should be documented or marked internal, resolve the RUSTUP_DIST_SERVER guidance, and ensure the documentation covers the supported variables.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100