Changes between Version 15 and Version 16 of Commentary/CodingStyle


Ignore:
Timestamp:
Sep 7, 2007 11:36:37 AM (7 years ago)
Author:
simonpj
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Commentary/CodingStyle

    v15 v16  
    44 = The GHC Commentary - Coding Style Guidelines for the compiler =  
    55 
    6 This is a rough description of some of the coding practices and style that we use for Haskell code inside {{{compiler}}}. See the [wiki:Commentary/Rts/Conventions Coding Style Guidelines for RTS C code] for code in {{{rts}}} and {{{include}}}. 
     6This is a rough description of some of the coding practices and style that we use for Haskell code inside {{{compiler}}}.  (For run-time system code see the [wiki:Commentary/Rts/Conventions Coding Style Guidelines for RTS C code].) 
    77 
    88The general rule is to stick to the same coding style as is already used in the file you're editing. If you must make stylistic changes, commit them separately from functional changes, so that someone looking back through the change logs can easily distinguish them.  
     
    1010== Warnings == 
    1111 
    12 We are aiming to make the GHC code warning-free for all warnings turned on by 
     12We are aiming to make the GHC code warning-free, for all warnings turned on by 
    1313{{{ 
    1414-Wall -fno-warn-name-shadowing 
    1515}}} 
    16 and as such the build sets these flags for the stage 2 compiler, and the validate script, which is used to test the build before commiting, additionally sets the `-Werror` flag. As the `-Werror` flag is not set during normal builds, during development warnings will be printed but won't halt the build. 
     16The build automatically sets these flags for the stage 2 compiler.   
     17 
     18The [wiki:TestingPatches validate script], which is used to test the build before commiting, additionally sets the `-Werror` flag. As the `-Werror` flag is not set during normal builds, during development warnings will be printed but won't halt the build. 
    1719 
    1820Currently we are some way from our goal, so many modules have a