Thread (3 messages) 3 messages, 2 authors, 2018-03-15

Re: [PATCH] Documentation/CodingStyle: Add an example for braces

From: Jani Nikula <jani.nikula@linux.intel.com>
Date: 2018-03-15 10:25:17
Also in: lkml

On Wed, 14 Mar 2018, Gary R Hook [off-list ref] wrote:
quoted hunk ↗ jump to hunk
Add another example of required braces when using a compound statement in
a loop.

Signed-off-by: Gary R Hook <redacted>
---
 Documentation/process/coding-style.rst |    9 +++++++++
 1 file changed, 9 insertions(+)
diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
index a20b44a40ec4..d98deb62c400 100644
--- a/Documentation/process/coding-style.rst
+++ b/Documentation/process/coding-style.rst
@@ -200,6 +200,15 @@ statement; in the latter case use braces in both branches:
 		otherwise();
 	}
 
+Also, use braces when a loop contains more than a single simple statement:
Personally, I'd not limit this to loops.

	if (condition) {
        	if (another_condition)
                	action();
        }

You could argue the existing rule already covers these cases by
excluding selection and iteration statements from the "single statement"
in "Do not unnecessarily use braces where a single statement will do."

BR,
Jani.
+
+.. code-block:: c
+
+	while (condition) {
+		if (test)
+			do_something();
+	}
+
 3.1) Spaces
 ***********
 

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
-- 
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help