CODING: one-line if statements should not have braces 70/12370/2
authorMichael Meffie <mmeffie@sinenomine.net>
Wed, 17 Aug 2016 14:57:48 +0000 (10:57 -0400)
committerBenjamin Kaduk <kaduk@mit.edu>
Sun, 11 Sep 2016 22:45:00 +0000 (18:45 -0400)
Update the style guide with a declaration of the prevailing and
preferred brace style for one-line if statements and loops. Provide an
example and counter-example.

Change-Id: Iafeea977203b76c0e67385779fb4ed57f3c6699a
Reviewed-on: https://gerrit.openafs.org/12370
Reviewed-by: Stephan Wiesand <stephan.wiesand@desy.de>
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>

CODING

diff --git a/CODING b/CODING
index f8a3fd4..fe64431 100644 (file)
--- a/CODING
+++ b/CODING
@@ -93,7 +93,29 @@ Example:
         * like this example.
         */
 
-\f
+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