[commit: ghc] master: Document +RTS -xq (65d1c03)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/65d1c0359394dc78551c5fb73a0934aa88b8d9f4/ghc

>---------------------------------------------------------------

commit 65d1c0359394dc78551c5fb73a0934aa88b8d9f4
Author: Simon Marlow <marlowsd at gmail.com>
Date:   Tue Nov 25 13:33:51 2014 +0000

    Document +RTS -xq


>---------------------------------------------------------------

65d1c0359394dc78551c5fb73a0934aa88b8d9f4
 docs/users_guide/runtime_control.xml | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/docs/users_guide/runtime_control.xml b/docs/users_guide/runtime_control.xml
index 612a441..a55a1fe 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>
+           [Default: 100k] 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>