Rollup merge of #104537 - HintringerFabian:docs_default_min_stack_size, r=the8472

fix std::thread docs are unclear regarding stack sizes

Improves the documentation about the default stack size of a spawned thread
Fixes #102671
This commit is contained in:
Matthias Krüger 2022-11-20 18:21:47 +01:00 committed by GitHub
commit ddb12348ca
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -124,9 +124,8 @@
//!
//! ## Stack size
//!
//! The default stack size for spawned threads is 2 MiB, though this particular stack size is
//! subject to change in the future. There are two ways to manually specify the stack size for
//! spawned threads:
//! The default stack size is platform-dependent and subject to change. Currently it is 2MB on all
//! Tier-1 platforms. There are two ways to manually specify the stack size for spawned threads:
//!
//! * 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