Ian

I have become quite obsessive about adding comments to source code to explain 
design decisions.  In this case, I'll commit a patch to add your darcs comment 
to the appropriate line of validate-settings.mk.  I know the info is in the 
commit message, but my experience is that commit messages are too indirect when 
you are looking at source code.

| Thu Aug 28 07:23:20 PDT 2008  Ian Lynagh <[EMAIL PROTECTED]>
|   * Turn on optimisation for stage2 when validating
|   This brings my validate down from 22mins to 16 mins.
|   Compiling stage2 takes longer, but we gain a faster haddock, faster
|   running of the tests, and faster building of the utils to be installed.


Another example that went by today is this:

| Thu Aug 28 05:48:14 PDT 2008  Ian Lynagh <[EMAIL PROTECTED]>
|   * Update the build system to handle building and using haddock2
|   One side-effect of this is that we need to build the install-utils with
|   stage2 rather than stage1 as we need the ghc package.

This looks like another tricky point that might benefit from a clarifying 
comment to explain why we must build utils twice?  (Or is it once but with 
stage2, I'm not sure.)  It's so easy to forget these constraints.

In general, the ideas here
        http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle
probably apply equally well to the build system

Simon


_______________________________________________
Cvs-ghc mailing list
[email protected]
http://www.haskell.org/mailman/listinfo/cvs-ghc

Reply via email to