[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <20250509203430.3448-8-adobriyan@gmail.com>
Date: Fri, 9 May 2025 23:34:29 +0300
From: Alexey Dobriyan <adobriyan@...il.com>
To: corbet@....net
Cc: workflows@...r.kernel.org,
linux-kernel@...r.kernel.org,
Alexey Dobriyan <adobriyan@...il.com>
Subject: [PATCH 8/9] CodingStyle: tell people how to split long "for" loops
Signed-off-by: Alexey Dobriyan <adobriyan@...il.com>
---
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
Powered by blists - more mailing lists