[project @ 2002-02-04 12:22:33 by simonmar]
[ghc-hetmet.git] / mk / config.mk.in
index 638791b..27d8845 100644 (file)
@@ -3,33 +3,26 @@
 #
 ################################################################################
 #
-#                      config.mk.in-template
+# config.mk.in
 #
-#      This file defines all the variables that set the configuration of
-#      a particular build.
+# This file supplies defaults for many tweakable build configuration
+# options.  Some of the defaults are filled in by the autoconf-generated
+# configure script.
 #
+# DO NOT EDIT THIS FILE!
 #
-################################################################################
-
-# The configuration is defined in two steps:
-#
-#      1. The builder (i.e. the person doing the build)
-#         copies this file, config.mk.in-template
-#         to config.mk.in
+#      - config.mk is auto-generated from config.mk.in by configure.
+#        This may be triggered automatically by the build system (say
+#        if config.mk.in has changed more recently than config.mk),
+#        so if you edit config.mk your changes will be spammed.
 #
-#      2. S/he then edits it manually (gasp) to reflect any configuration
-#         options s/he wants.
-#
-#      3. Then s/he runs "configure", which generates config.mk from
-#         config.mk.in, substituting for system/platform-dependent things
-#         enclosed in @at-signs@.
+#      - Settings in this file may be overriden by giving replacement
+#        definitions in build.mk.  If you don't have a build.mk file
+#        then you get defaults for everything.  The defaults should
+#        provide a reasonable vanilla build.
 #
 # This is one of only two files that configure generates (the other is config.h)
 #
-# Note that after subsequent edits of config.mk.in for a build, the configure script
-# will have to be re-run manually to have the change reflected in config.mk. 
-#
-
 # There is a section below for each project within the fptools suite
 #
 #      PLUS
@@ -299,11 +292,22 @@ StripLibraries=NO
 
 # For an optimised RTS:
 GhcRtsHcOpts=-O2
-GhcRtsCcOpts=-O2 -fomit-frame-pointer
+GhcRtsCcOpts=-fomit-frame-pointer
 
 # Include the front panel code?  Needs GTK+.
 GhcRtsWithFrontPanel = NO
 
+#
+# To have the RTS support interoperation with OS threads, set
+# GhcRtsThreaded to YES (preferably via the --enable-threaded-rts
+# configure script option). The consequence of this is spelled out
+# in details elsewhere, but, briefly, Concurrent Haskell threads
+# can now make external (i.e., C) calls without blocking the progress
+# of other CH threads. Multiple native threads can also execute
+# Haskell code without getting in each others way too.
+# 
+GhcRtsThreaded=@ThreadedRts@
+
 ################################################################################
 #
 #              hslibs project
@@ -436,10 +440,10 @@ ifeq "$(TARGETPLATFORM)" "i386-unknown-mingw32"
 DEFAULT_TMPDIR         = C:/TEMP
 endif
 
-# FPTOOLS_TOP: the top of the fptools hierarchy, absolute path. (platform-specific format).
-FPTOOLS_TOP_ABS                = @hardtop_plat@
-# Keep the Unix-style path to use with Unix tools (e.g. in ghc-inplace script)
-FPTOOLS_TOP_ABS_UNIX    = @hardtop@
+# FPTOOLS_TOP: the top of the fptools hierarchy, absolute path. (POSIX / unix-style path).
+FPTOOLS_TOP_ABS                = @hardtop@
+# The platform specific version of 'hardtop'.
+FPTOOLS_TOP_ABS_PLATFORM = @hardtop_plat@
 
 #
 # Installation directories, we don't use half of these,