From: Felix Raimundo <felix.raimundo@tweag.io>
Date: Sun, 7 May 2017 16:42:36 +0000 (+0200)
Subject: Add stack size doc to `thread::spawn`.
X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=ddb9e50b45b9762e09d341cce8547055cbee4840;p=rust.git

Add stack size doc to `thread::spawn`.

Part of #29378
---

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 {