[oprof-cvs] CVS: oprofile/doc CodingStyle,1.6,1.7

[John L. <mov...@us...>]

Update of /cvsroot/oprofile/oprofile/doc
In directory sc8-pr-cvs1:/tmp/cvs-serv5875/doc

Modified Files:
	CodingStyle 
Log Message:
small additions to CodingStyle


Index: CodingStyle
===================================================================
RCS file: /cvsroot/oprofile/oprofile/doc/CodingStyle,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -p -d -r1.6 -r1.7
--- CodingStyle	22 Sep 2003 14:10:13 -0000	1.6
+++ CodingStyle	4 Nov 2003 03:03:23 -0000	1.7
@@ -11,6 +11,7 @@ General points
 Keep lines within 80 columns with a maximum tab size of 8.
 
 Keep files (especially headers) focussed on one small aspect.
+Make judicious use of forward declarations.
 
 	Rationale: reduce false include dependencies
 
@@ -19,7 +20,7 @@ utility library (e.g. libop/, libutil++)
 
 	Rationale: re-use, clean organisation
 
-Make judicious use of forward declarations.
+Avoid complex conditionals via helper functions (e.g. comma_match)
 
 Avoid ifdefs: prefer configure options / build trickery.
 
@@ -34,7 +35,8 @@ LIST = \
 	foo2
 rather than
 LIST = foo1 foo2
-	Rationale: diff are a lot of easier to read.
+
+	Rationale: diffs are a lot easier to read.
 
 Arbitrary rules
 ---------------
@@ -94,6 +96,9 @@ Use the standard comments + include guar
 Do not inline unless you have good reason.
 
 Use anon namespaces for static variables.
+
+In a derived class re-implementing a virtual function, include the
+(unnecessary) "virtual" keyword in the function declaration.
 
 "nr_doobries" not "no_doobries" - disambiguates between "number" and "negative"