From: simonm <unknown>
Date: Mon, 26 Apr 1999 09:39:21 +0000 (+0000)
Subject: [project @ 1999-04-26 09:39:21 by simonm]
X-Git-Tag: Approximately_9120_patches~6309
X-Git-Url: http://git.megacz.com/?a=commitdiff_plain;h=3ee9bf03d1d7289869b178f81c793cf422d04152;p=ghc-hetmet.git

[project @ 1999-04-26 09:39:21 by simonm]
Add note about needing -optCrts before RTS options for the compiler itself.
---

diff --git a/ghc/docs/users_guide/runtime_control.vsgml b/ghc/docs/users_guide/runtime_control.vsgml
index 50d2745..baea188 100644
--- a/ghc/docs/users_guide/runtime_control.vsgml
+++ b/ghc/docs/users_guide/runtime_control.vsgml
@@ -48,6 +48,12 @@ Giving a @+RTS -f@<nidx>-f RTS option</nidx> option will print out the
 RTS options actually available in your program (which vary, depending
 on how you compiled).
 
+NOTE: to send RTS options to the compiler itself, you need to prefix
+the option with @-optCrts@, eg. to increase the maximum heap size for
+a compilation to 128M, you would add @-optCrts-M128m@ to the command
+line.  The compiler understands some options directly without needing
+@-optCrts@: these are @-H@ and @-K@.
+
 %************************************************************************
 %*                                                                      *
 <sect2>RTS options to control the garbage-collector