diff options
| author | Matthias Krüger <matthias.krueger@famsik.de> | 2023-04-14 07:58:38 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-14 07:58:38 +0200 |
| commit | ec08676716631fc7ccefb58141f891bd86cd175d (patch) | |
| tree | 569ae9584613bf19f5dc7730635e5ac70c76eec8 | |
| parent | d558796beb400cceb2a2b8950f35aa518a58a586 (diff) | |
| parent | 6eef755012a0f1ac0c40148b7135a125e512f6f0 (diff) | |
| download | rust-ec08676716631fc7ccefb58141f891bd86cd175d.tar.gz rust-ec08676716631fc7ccefb58141f891bd86cd175d.zip | |
Rollup merge of #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.
| -rw-r--r-- | library/std/src/thread/mod.rs | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/library/std/src/thread/mod.rs b/library/std/src/thread/mod.rs index b9aaf5f6e15..13b845b25c9 100644 --- a/library/std/src/thread/mod.rs +++ b/library/std/src/thread/mod.rs @@ -131,7 +131,8 @@ //! //! * Build the thread with [`Builder`] and pass the desired stack size to [`Builder::stack_size`]. //! * Set the `RUST_MIN_STACK` environment variable to an integer representing the desired stack -//! size (in bytes). Note that setting [`Builder::stack_size`] will override this. +//! size (in bytes). Note that setting [`Builder::stack_size`] will override this. Be aware that +//! changes to `RUST_MIN_STACK` may be ignored after program start. //! //! Note that the stack size of the main thread is *not* determined by Rust. //! |