Skip to content

Commit aa49080

Browse files
authored
Rollup merge of rust-lang#109225 - seanlinsley:patch-1, r=ChrisDenton
Clarify that RUST_MIN_STACK may be internally cached For larger applications it's important that users set `RUST_MIN_STACK` at the start of their program because [`min_stack`](https://github.com/rust-lang/rust/blob/7d3e03666a93bd2b0f78b3933f9305832af771a5/library/std/src/sys_common/thread.rs) caches the value. Not doing so can lead to their `env::set_var` call surprisingly not having any effect. In my own testing `RUST_MIN_STACK` had no effect until I moved it to the top of `main()`. Hopefully this clarification in the docs will help others going forward.
2 parents d558796 + 6eef755 commit aa49080

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

library/std/src/thread/mod.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,8 @@
131131
//!
132132
//! * Build the thread with [`Builder`] and pass the desired stack size to [`Builder::stack_size`].
133133
//! * Set the `RUST_MIN_STACK` environment variable to an integer representing the desired stack
134-
//! size (in bytes). Note that setting [`Builder::stack_size`] will override this.
134+
//! size (in bytes). Note that setting [`Builder::stack_size`] will override this. Be aware that
135+
//! changes to `RUST_MIN_STACK` may be ignored after program start.
135136
//!
136137
//! Note that the stack size of the main thread is *not* determined by Rust.
137138
//!

0 commit comments

Comments
 (0)