X-Git-Url: http://git.openafs.org/?p=openafs.git;a=blobdiff_plain;f=CODING;h=fe64431579f40e8b34b758fb26d91d85e68acfd9;hp=6a1af056594f5e84c96fe2f9e7ecd2f81f18b2c9;hb=a6ad67485bf23084c06e1de1a424b2e375ee70f3;hpb=93f7041a08526b1c3ac37197cd7bee40c7430010 diff --git a/CODING b/CODING index 6a1af05..fe64431 100644 --- 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.) - +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