[PATCH 8/9] CodingStyle: tell people how to split long "for" loops

From: Alexey Dobriyan
Date: Fri May 09 2025 - 16:37:20 EST


Signed-off-by: Alexey Dobriyan <adobriyan@xxxxxxxxx>
---
Documentation/process/coding-style.rst | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
index e17de69845ff..494ab3201112 100644
--- a/Documentation/process/coding-style.rst
+++ b/Documentation/process/coding-style.rst
@@ -183,7 +183,21 @@ Descendants are always substantially shorter than the parent and
are placed substantially to the right. A very commonly used style
is to align descendants to a function open parenthesis.

-These same rules are applied to function headers with a long argument list.
+These same rules are applied to function prototypes with a long argument list.
+
+Very long ``for`` loops are split at the ``;`` characters making it easier
+to see which code goes to which clause:
+
+.. code-block:: c
+
+ for (int i = 0;
+ i < N;
+ i += 1)
+ {
+ }
+
+Opening curly is placed on a separate line then to make it easier to tell
+loop body from iteration clause.

However, never break user-visible strings such as printk messages because
that breaks the ability to grep for them.
--
2.49.0