[commit: ghc] master: build.mk.sample: Document meaning of WERROR (02c689c)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/02c689cd1ce2a55adf6318eb9bd69f227f1abda2/ghc

>---------------------------------------------------------------

commit 02c689cd1ce2a55adf6318eb9bd69f227f1abda2
Author: Ben Gamari <ben at smart-cactus.org>
Date:   Mon Nov 23 11:35:34 2015 +0100

    build.mk.sample: Document meaning of WERROR
    
    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.


>---------------------------------------------------------------

02c689cd1ce2a55adf6318eb9bd69f227f1abda2
 mk/build.mk.sample | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/mk/build.mk.sample b/mk/build.mk.sample
index 4f83ebb..196becb 100644
--- a/mk/build.mk.sample
+++ b/mk/build.mk.sample
@@ -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: