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

Timestamp:

07/08/11 18:45:57 (23 months ago)

Author:

dterei

Comment:

--

Commentary/Rts/Conventions

@@ -1 @@
-
-
 = The GHC Commentary: Coding Style Guidelines for RTS C code =
 
@@ -8 +6 @@
 {{{rts/}}} and {{{includes/}}}.  See [wiki:Commentary/CodingStyle Coding Style Guidelines] for code in {{{compiler/}}}.
 
-NB. This page is pretty old.
-
-NB. These are just suggestions.  They're not set in stone.  Some of
+These are just suggestions.  They're not set in stone.  Some of
 them are probably misguided.  If you disagree with them, feel free to
 modify this document (and make your commit message reasonably
-informative) or mail someone (eg. [mailto:glasgow-haskell-users@haskell.org The GHC mailing list])
+informative) or mail someone
+(eg. [mailto:glasgow-haskell-users@haskell.org The GHC mailing list])
 
 == References ==
@@ -22 +19 @@
  * The C99 standard.  One reasonable reference is [http://home.tiscalinet.ch/t_wolf/tw/c/c9x_changes.html here].
 
- * Writing Solid Code, Microsoft Press.  (Highly recommended.)
-
- * Autoconf documentation.  See also
+ * Writing Solid Code, Microsoft Press. (Highly recommended.)
+
+ * Autoconf documentation. See also
    [http://peti.gmd.de/autoconf-archive/ The autoconf macro archive]
    and [http://www.cyclic.com/cyclic-pages/autoconf.html Cyclic Software's description].
@@ -402 +399 @@
 == Source-control issues ==
 
- * Don't be tempted to reindent or reorganise large chunks of code -
+ * Don't be tempted to re-indent or re-organise large chunks of code -
    it generates large diffs in which it's hard to see whether anything
    else was changed, and causes extra conflicts when moving patches to
    another branch.
 
-  If you must reindent or reorganise, don't include any functional
+  If you must re-indent or re-organise, don't include any functional
   changes that commit and give advance warning that you're about to do
   it in case anyone else is changing that file.