[maemo-commits] [maemo-commits] r9663 - projects/haf/branches/hildon-libs/hildon-1

[From: subversion at stage.maemo.org]

Author: mdk
Date: 2007-02-06 12:17:33 +0200 (Tue, 06 Feb 2007)
New Revision: 9663

Added:
   projects/haf/branches/hildon-libs/hildon-1/HACKING
Modified:
   projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2
Log:
Adding a HACKING file with some basic rules of styling and code formatting.


Modified: projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2
===================================================================
--- projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2	2007-02-06 10:16:41 UTC (rev 9662)
+++ projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2	2007-02-06 10:17:33 UTC (rev 9663)
@@ -1,5 +1,10 @@
 2007-02-06  Michael Dominic Kostrzewa  <michael.kostrzewa at nokia.com> 
 
+	* HACKING: Adding a HACKING file with some basic rules of styling and
+	code formatting.
+
+2007-02-06  Michael Dominic Kostrzewa  <michael.kostrzewa at nokia.com> 
+
 	* src/hildon-color-button.c:
 	* src/hildon-color-button.h: Updating documentation.
 

Added: projects/haf/branches/hildon-libs/hildon-1/HACKING
===================================================================
--- projects/haf/branches/hildon-libs/hildon-1/HACKING	2007-02-06 10:16:41 UTC (rev 9662)
+++ projects/haf/branches/hildon-libs/hildon-1/HACKING	2007-02-06 10:17:33 UTC (rev 9663)
@@ -0,0 +1,29 @@
+The general rules of conduct are:
+
+* Code identation is 4 spaces NO TABS
+* Function parameters start at column 48, one param per line
+* Use inside-code gtk doc documentation for everything 
+* Do not put documentation outside of the code
+* Use g_assert's inside private functions where it makes sense (they're not
+  compiled-in by default)
+* Put space to separate operators. Ie:
+
+{
+    some_function (param1, param2);
+    a = 1 + 2;
+    b [1] = 10;
+}
+
+NEVER EVER DO:
+
+{
+    some_function(param1,param2);
+    a=1+2;
+    b[1]=10;
+}
+
+* Small testing programs can be put in the examples/ directory. They can be run
+  without installation blah blah blah blah blah blah blah blah  
+* Obey the rules present in the existing code base -- it's pretty consistent
+* Use ONE blank line to separate things 
+