From: Simon Marlow <marlowsd@gmail.com>
Date: Tue, 14 Dec 2010 10:13:40 +0000 (+0000)
Subject: comments on SRC_HC_OPTS (#4829)
X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=commitdiff_plain;h=99b6e6ac44c6c610b0d60e3b70a2341c83d23106

comments on SRC_HC_OPTS (#4829)
---

diff --git a/mk/config.mk.in b/mk/config.mk.in
index 4e61732..5b04f6b 100644
--- a/mk/config.mk.in
+++ b/mk/config.mk.in
@@ -386,6 +386,23 @@ WINDOWS_INSTALLER = $(WINDOWS_INSTALLER_BASE)$(exeext)
 #
 #	SRC_HC_OPTS += -O
 
+
+# SRC_HC_OPTS includes flags to be added to *every* Haskell
+# compilation.  Setting SRC_HC_OPTS is a good way to set the default
+# optimisation level (-O) and heap size (-H<size>).
+# 
+# SRC_HC_OPTS is *not* for adding flags that are required to make your
+# build work.  Examples:
+#
+#  - instead of using -pgmc/-pgma-/-pgml, use the --with-gcc option to configure
+#
+#  - if you need -optc, -opta, or -optl flags, the CONF_CC_* and CONF_LD_*
+#    variables are more appropriate (set via configure)
+#
+# Note that SRC_HC_OPTS are added to every Haskell compilation,
+# including when using the bootstrapping compiler (stage 0), So don't
+# put options here that are only supported by very recent GHCs.
+#
 SRC_HC_OPTS += -H32m -O
 
 # These flags make flex 8-bit