summaryrefslogtreecommitdiff
path: root/docs/users_guide/phases.xml
diff options
context:
space:
mode:
authorSimon Marlow <marlowsd@gmail.com>2011-11-16 15:40:40 +0000
committerSimon Marlow <marlowsd@gmail.com>2011-11-16 15:40:40 +0000
commitbea3992c71be47db7f2fc53f3e358212d1539706 (patch)
tree9ae1639c831a5be16161d4bf758c030bb3d92f5e /docs/users_guide/phases.xml
parent1bbb89f3ab009367fcca84b73b351ddcf5be16a4 (diff)
downloadhaskell-bea3992c71be47db7f2fc53f3e358212d1539706.tar.gz
Doc changes following changes to the way -rtsopts works
Mainly, -rtsopts doesn't work with -no-hs-main, and you have to do something in your main() to get the effect of -rtsopts (and -with-rtsopts).
Diffstat (limited to 'docs/users_guide/phases.xml')
-rw-r--r--docs/users_guide/phases.xml24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/users_guide/phases.xml b/docs/users_guide/phases.xml
index 7158c14af4..2e23b95eaa 100644
--- a/docs/users_guide/phases.xml
+++ b/docs/users_guide/phases.xml
@@ -891,6 +891,18 @@ $ cat foo.hspp</screen>
<literal>Main</literal> module present (normally the
compiler will not attempt linking when there is no
<literal>Main</literal>).</para>
+
+ <para>The flags <option>-rtsopts</option>
+ and <option>-with-rtsopts</option> have no effect when
+ used with <option>-no-hs-main</option>, because they are
+ implemented by changing the definition
+ of <literal>main</literal> that GHC generates. See
+ <xref linkend="using-own-main" /> for how to get the
+ effect of <option>-rtsopts</option>
+ and <option>-with-rtsopts</option> when using your
+ own <literal>main</literal>.
+ </para>
+
</listitem>
</varlistentry>
@@ -1024,6 +1036,12 @@ $ cat foo.hspp</screen>
security problem. For this reason, GHC 7.0.1 and later
default to <option>-rtsops=some</option>.
</para>
+
+ <para>
+ Note that <option>-rtsopts</option> has no effect when
+ used with <option>-no-hs-main</option>; see
+ <xref linkend="using-own-main" /> for details.
+ </para>
</listitem>
</varlistentry>
@@ -1042,6 +1060,12 @@ $ cat foo.hspp</screen>
<option>-with-rtsopts</option> would be the <emphasis>only</emphasis> way to set
them.)
</para>
+
+ <para>
+ Note that <option>-with-rtsopts</option> has no effect when
+ used with <option>-no-hs-main</option>; see
+ <xref linkend="using-own-main" /> for details.
+ </para>
</listitem>
</varlistentry>