users_guide: Document zero stack size limit
authorBen Gamari <bgamari.foss@gmail.com>
Tue, 22 Oct 2013 14:45:38 +0000 (10:45 -0400)
committerAustin Seipp <austin@well-typed.com>
Fri, 25 Oct 2013 14:14:29 +0000 (09:14 -0500)
docs/users_guide/runtime_control.xml

index aed507b..32edc3f 100644 (file)
@@ -679,7 +679,8 @@ $ ./prog -f +RTS -H32m -S -RTS -h foo bar
          <para>&lsqb;Default: 8M&rsqb; Set the maximum stack size for
           an individual thread to <replaceable>size</replaceable>
           bytes.  If the thread attempts to exceed this limit, it will
-            be send the <literal>StackOverflow</literal> exception.
+          be sent the <literal>StackOverflow</literal> exception. The
+          limit can be disabled entiredly by specifying a size of zero.
           </para>
           <para>
             This option is there mainly to stop the program eating up