initial commit

1 files changed, 16 insertions, 0 deletions

diff --git a/CODING_STYLE b/CODING_STYLE
new file mode 100644
index 0000000000..1b8c8cf3c6
--- /dev/null
+++ b/CODING_STYLE
@@ -0,0 +1,16 @@
+
+- 8ch indent, no tabs
+
+- structs in MixedCase, variables, functions in lower_case
+
+- the destructors always unregister the object from the next bigger
+  object, not the other way around
+
+- to minimize strict aliasing violations we prefer unions over casting
+
+- for robustness reasons destructors should be able to destruct
+  half-initialized objects, too
+
+- error codes are returned as negative Exxx. i.e. return EINVAL. There
+  are some exceptions: for constructors its is OK to return NULL on
+  OOM. For lookup functions NULL is fine too for "not found".