summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSimon Marlow <marlowsd@gmail.com>2014-11-25 13:33:51 +0000
committerSimon Marlow <marlowsd@gmail.com>2014-11-25 14:37:26 +0000
commit65d1c0359394dc78551c5fb73a0934aa88b8d9f4 (patch)
treea14b39a29b74260923169212bd73f322c735d6ff /docs
parent452eb80f15fce8665df52bc9facebfafb5b6267b (diff)
downloadhaskell-65d1c0359394dc78551c5fb73a0934aa88b8d9f4.tar.gz
Document +RTS -xq
Diffstat (limited to 'docs')
-rw-r--r--docs/users_guide/runtime_control.xml20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/users_guide/runtime_control.xml b/docs/users_guide/runtime_control.xml
index 612a44122a..a55a1fe5e2 100644
--- a/docs/users_guide/runtime_control.xml
+++ b/docs/users_guide/runtime_control.xml
@@ -323,6 +323,26 @@ $ ./prog -f +RTS -H32m -S -RTS -h foo bar
</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><option>-xq<replaceable>size</replaceable></option>
+ <indexterm><primary><option>-xq</option></primary><secondary>RTS
+ option</secondary></indexterm></term>
+ <listitem>
+ <para>
+ &lsqb;Default: 100k&rsqb; This option relates to allocation
+ limits; for more about this see <ulink
+ url="&libraryBaseLocation;/GHC-Conc.html#v%3AenableAllocationLimit"><literal>enableAllocationLimit</literal></ulink>.
+ When a thread hits its allocation limit, the RTS throws an
+ exception to the thread, and the thread gets an additional
+ quota of allocation before the exception is raised again,
+ the idea being so that the thread can execute its exception
+ handlers. The <option>-xq</option> controls the size of
+ this additional quota.
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</sect2>