build.mk.sample: Document meaning of WERROR
authorBen Gamari <ben@smart-cactus.org>
Mon, 23 Nov 2015 10:35:34 +0000 (11:35 +0100)
committerBen Gamari <ben@smart-cactus.org>
Mon, 23 Nov 2015 10:35:34 +0000 (11:35 +0100)
31bcf9b62ceaed98bdd3b7605e68d315bcff0c8a changed the behavior of WERROR
such that it would only apply to the stage 2 build. The reason for this
was to avoid silly redundant imports and such breaking validation on
different bootstrap compiler versions.

Document the fact that WERROR now only applies to the stage 2 build.

mk/build.mk.sample

index 4f83ebb..196becb 100644 (file)
@@ -63,7 +63,8 @@ endif
 # Please use V=1 (the default) when reporting GHC bugs.
 #V=0
 
-# Should all enabled warnings (see mk/warnings.mk) be turned into errors?
+# Should all enabled warnings (see mk/warnings.mk) be turned into errors while
+# building stage 2?
 #WERROR=-Werror
 
 # After stage 1 and the libraries have been built, you can uncomment this line: