Changes between Version 8 and Version 9 of Commentary/Rts/Conventions


Ignore:
Timestamp:
Jul 9, 2011 1:45:57 AM (4 years ago)
Author:
dterei
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Commentary/Rts/Conventions

    v8 v9  
    1 
    2 
    31= The GHC Commentary: Coding Style Guidelines for RTS C code =
    42
     
    86{{{rts/}}} and {{{includes/}}}.  See [wiki:Commentary/CodingStyle Coding Style Guidelines] for code in {{{compiler/}}}.
    97
    10 NB. This page is pretty old.
    11 
    12 NB. These are just suggestions.  They're not set in stone.  Some of
     8These are just suggestions.  They're not set in stone.  Some of
    139them are probably misguided.  If you disagree with them, feel free to
    1410modify this document (and make your commit message reasonably
    15 informative) or mail someone (eg. [mailto:[email protected] The GHC mailing list])
     11informative) or mail someone
     12(eg. [mailto:[email protected] The GHC mailing list])
    1613
    1714== References ==
     
    2219 * The C99 standard.  One reasonable reference is [http://home.tiscalinet.ch/t_wolf/tw/c/c9x_changes.html here].
    2320
    24  * Writing Solid Code, Microsoft Press.  (Highly recommended.)
    25 
    26  * Autoconf documentation.  See also
     21 * Writing Solid Code, Microsoft Press. (Highly recommended.)
     22
     23 * Autoconf documentation. See also
    2724   [http://peti.gmd.de/autoconf-archive/ The autoconf macro archive]
    2825   and [http://www.cyclic.com/cyclic-pages/autoconf.html Cyclic Software's description].
     
    402399== Source-control issues ==
    403400
    404  * Don't be tempted to reindent or reorganise large chunks of code -
     401 * Don't be tempted to re-indent or re-organise large chunks of code -
    405402   it generates large diffs in which it's hard to see whether anything
    406403   else was changed, and causes extra conflicts when moving patches to
    407404   another branch.
    408405
    409   If you must reindent or reorganise, don't include any functional
     406  If you must re-indent or re-organise, don't include any functional
    410407  changes that commit and give advance warning that you're about to do
    411408  it in case anyone else is changing that file.