summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorDirk-Jan C. Binnema <djcb@djcbsoftware.nl>2010-01-04 20:24:28 +0200
committerDirk-Jan C. Binnema <djcb@djcbsoftware.nl>2010-01-04 20:24:28 +0200
commit9512b36c32e1284db0a82641e936c07f8a0c87af (patch)
tree82b7c85c5d6610e886f1c6f4f292a2f9dbf54ae7 /HACKING
parent7f5eaf148a44b53b0d4a1be2084bc8aa7cee196a (diff)
* HACKING: updated coding guidelines
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING20
1 files changed, 9 insertions, 11 deletions
diff --git a/HACKING b/HACKING
index cd6cfb5..931e1d6 100644
--- a/HACKING
+++ b/HACKING
@@ -1,6 +1,11 @@
* HACKING
-Here are some short guidelines for hacking on the 'mu' source code.
+Here are some short guidelines for hacking on the 'mu' source code. Note, this
+is fairly long list. This is not meant to discourage anyone from working on
+the mu source code; I think most of the rules are common sense anyway, and
+some of the more stylistic-aesthetic rules are clearly visible in current
+source code, so as long as any new code 'fits in', it should go a long way in
+satisfying these rules.
** Coding style
@@ -13,7 +18,7 @@ Here are some short guidelines for hacking on the 'mu' source code.
2. lines must not exceed 80 characters
- 3. functions must not exceed 30 lines (there may be rare exceptions), and
+ 3. functions must not exceed 50 lines (there may be rare exceptions), and
30 lines is already pretty long.
4. source files should not exceed 1000 lines
@@ -28,7 +33,7 @@ Here are some short guidelines for hacking on the 'mu' source code.
declares a function of 'mu_foo_bar (int a);', mu-foo.c implements this.
8. non-global functions *don't* have the module prefix, and are declared
- static.
+ static. Their names may start with '_'
9. functions have their return type on a separate line before the function
name
@@ -41,14 +46,7 @@ Here are some short guidelines for hacking on the 'mu' source code.
not to be freed, 'const char*' should be used instead
-
-
-
-
-
-
-
-
#+ Local Variables: ***
#+ mode:org ***
#+ End: ***
+