about summary refs log tree commit diff
path: root/src/libstd/thread
diff options
context:
space:
mode:
authorFelix Raimundo <felix.raimundo@tweag.io>2017-05-07 18:42:36 +0200
committerFelix Raimundo <felix.raimundo@tweag.io>2017-05-07 19:31:17 +0200
commitddb9e50b45b9762e09d341cce8547055cbee4840 (patch)
tree88c660dbe81f34a70551dd2c5e5166fca6415297 /src/libstd/thread
parentced823e267c132fab172b1890b24073995e79ffa (diff)
downloadrust-ddb9e50b45b9762e09d341cce8547055cbee4840.tar.gz
rust-ddb9e50b45b9762e09d341cce8547055cbee4840.zip
Add stack size doc to `thread::spawn`.
Part of #29378
Diffstat (limited to 'src/libstd/thread')
-rw-r--r--src/libstd/thread/mod.rs7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/libstd/thread/mod.rs b/src/libstd/thread/mod.rs
index 4cbcfdbc2d7..2f7a17af779 100644
--- a/src/libstd/thread/mod.rs
+++ b/src/libstd/thread/mod.rs
@@ -244,6 +244,11 @@ impl Builder {
     /// Generates the base configuration for spawning a thread, from which
     /// configuration methods can be chained.
     ///
+    /// If the [`stack_size`][stack_size] field is not specified, the stack size
+    /// will be the `RUST_MIN_STACK` environment variable, if it is
+    /// not specified either, a sensible default size will be set (2MB as
+    /// of the writting of this doc).
+    ///
     /// # Examples
     ///
     /// ```
@@ -259,6 +264,8 @@ impl Builder {
     ///
     /// handler.join().unwrap();
     /// ```
+    ///
+    /// [stack_size]: ../../std/thread/struct.Builder.html#method.stack_size
     #[stable(feature = "rust1", since = "1.0.0")]
     pub fn new() -> Builder {
         Builder {