unstable-book: Add stubs for environment variables; document some of the important ones #141624
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rustbot
added
A-tidy
jyn514
commented
May 27, 2025
src/doc/unstable-book/src/compiler-environment-variables/TERM.md
Outdated
Show resolved
Hide resolved
This uses a very hacky regex that will probably miss some variables. But having some docs seems better than none at all. This uses a very hacky regex that will probably miss some variables. But having some docs seems better than none at all. In particular, this generates stubs for the following env vars: - COLORTERM - QNX_TARGET - RUST_BACKTRACE - RUSTC_BLESS - RUSTC_BOOTSTRAP - RUSTC_BREAK_ON_ICE - RUSTC_CTFE_BACKTRACE - RUSTC_FORCE_RUSTC_VERSION - RUSTC_GRAPHVIZ_FONT - RUSTC_ICE - RUSTC_LOG - RUSTC_OVERRIDE_VERSION_STRING - RUSTC_RETRY_LINKER_ON_SEGFAULT - RUSTC_TRANSLATION_NO_DEBUG_ASSERT - RUST_DEP_GRAPH_FILTER - RUST_DEP_GRAPH - RUST_FORBID_DEP_GRAPH_EDGE - RUST_MIN_STACK - RUST_TARGET_PATH - SDKROOT - TERM - UNSTABLE_RUSTDOC_TEST_LINE - UNSTABLE_RUSTDOC_TEST_PATH [rendered]()
BoxyUwU
approved these changes
Aug 8, 2025
BoxyUwU
added
S-waiting-on-author
madsmtm
approved these changes
Aug 8, 2025
| @@ -0,0 +1,6 @@ | |||
| # `SDKROOT` | |||
|
|
|||
| This environment variable is used on MacOS targets. | |||
There was a problem hiding this comment.
Suggested change
| This environment variable is used on MacOS targets. | |
| This environment variable is used on Apple targets. |
| # `SDKROOT` | ||
|
|
||
| This environment variable is used on MacOS targets. | ||
| It is passed through to the linker (either as `-isysroot` or `-syslibroot`) without changes. |
There was a problem hiding this comment.
I still plan to change this in #131477 (though if you want, you can keep the text as-is for now).
Suggested change
| It is passed through to the linker (either as `-isysroot` or `-syslibroot`) without changes. | |
| It is passed through to the linker (currently either as `-isysroot` or `-syslibroot`). |
flba-eb
reviewed
Aug 9, 2025
| See [the QNX docs] for more background information. | ||
|
|
||
| [set this variable]: https://www.qnx.com/developers/docs/qsc/com.qnx.doc.qsc.inst_larg_org/topic/build_server_developer_steps.html | ||
| [the QNX docs]: https://www.qnx.com/developers/docs/7.1/index.html#com.qnx.doc.neutrino.io_sock/topic/migrate_app.html. |
There was a problem hiding this comment.
Suggested change
| [the QNX docs]: https://www.qnx.com/developers/docs/7.1/index.html#com.qnx.doc.neutrino.io_sock/topic/migrate_app.html. | |
| [the QNX docs]: https://www.qnx.com/developers/docs/7.1/#com.qnx.doc.neutrino.io_sock/topic/migrate_app.html. |
Blackberry changed the link. Would be great if you could also update the link in compiler/rustc_target/src/spec/base/nto_qnx.rs!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This uses a very hacky regex that will probably miss some variables. But having some docs seems better than none at all.
In particular, this documents the following env vars explicitly (cc @madsmtm @flba-eb - do the docs for SDKROOT and QNX_TARGET look right?):
and generates stubs for the following env vars:
rendered: