relocate old afs docs to doc/txt
[openafs.git] / CODING
diff --git a/CODING b/CODING
index 6a1af05..fe64431 100644 (file)
--- a/CODING
+++ b/CODING
@@ -83,7 +83,39 @@ Suggested compiler flags:
                (You might not want the -fd, it isn't really useful, just complains about the
                K&R style functions, but -v gives useful info.)
 
-\f
+Multiple line comment blocks should begin with only /* on one line and end with
+only */ on one line.
+
+Example:
+
+       /*
+        * Multiple line comment blocks should be formatted
+        * like this example.
+        */
+
+Do not use braces on one-line if and loop statements.
+
+Use:
+
+       if (some_condition)
+           do_some_action();
+       else
+           do_something_else();
+
+       while (some_condition)
+           do_something();
+
+Instead of:
+
+       if (some_condition) {
+           do_some_action();
+       }
+
+       while (some_condition) {
+           do_something();
+       }
+
+
 Dependencies required to build OpenAFS from source
 --------------------------------------------------
 The following packages are required to build all of the OpenAFS code