2018-03-26 16:25:59

by Gary R Hook

[permalink] [raw]
Subject: [PATCH v3] Documentation/CodingStyle: Add an example for braces

Add another example of required braces when using a compound statement in
a loop.

Signed-off-by: Gary R Hook <[email protected]>
---

Changes since v2:
- Modified the example code fragment

Changes since v1:
- Move the new example up, and make it more generic

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..24903244c8be 100644
--- a/Documentation/process/coding-style.rst
+++ b/Documentation/process/coding-style.rst
@@ -188,6 +188,15 @@ and
else
do_that();

+Do use braces when a body is more complex than a single simple statement:
+
+.. code-block:: c
+
+ if (condition) {
+ while (some_loop_condition)
+ do_something();
+ }
+
This does not apply if only one branch of a conditional statement is a single
statement; in the latter case use braces in both branches: