[project @ 2001-11-27 12:29:44 by simonmar]

The notes at the top of this file were wrong, and totally confusing.
As far as I can tell, they never matched reality.

This commit up the comments, and adds a warning about editing this
file directly (a common mistake with fptools newbies).

diff --git a/mk/config.mk.in b/mk/config.mk.in
index ea61013..47c4174 100644 (file)
--- a/mk/config.mk.in
+++ b/mk/config.mk.in
@@ -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