summaryrefslogtreecommitdiff
path: root/Documentation/dev-tools/checkpatch.rst
diff options
context:
space:
mode:
authorMaxime Ripard <mripard@kernel.org>2024-05-27 11:08:31 +0200
committerMaxime Ripard <mripard@kernel.org>2024-05-27 11:08:31 +0200
commit375c4d1583948cf2439833e4a85d5a0aee853895 (patch)
tree821f494e7df09af36887f710cfce1fb89600e666 /Documentation/dev-tools/checkpatch.rst
parent983095eaf6c161ef73d96152bfc1a99ca051cd57 (diff)
parent1613e604df0cd359cf2a7fbd9be7a0bcfacfabd0 (diff)
Merge drm/drm-next into drm-misc-next
Let's start the new release cycle. Signed-off-by: Maxime Ripard <mripard@kernel.org>
Diffstat (limited to 'Documentation/dev-tools/checkpatch.rst')
-rw-r--r--Documentation/dev-tools/checkpatch.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
index 127968995847..a9fac978a525 100644
--- a/Documentation/dev-tools/checkpatch.rst
+++ b/Documentation/dev-tools/checkpatch.rst
@@ -906,6 +906,20 @@ Macros, Attributes and Symbols
See: https://lore.kernel.org/lkml/1399671106.2912.21.camel@joe-AO725/
+ **MACRO_ARG_UNUSED**
+ If function-like macros do not utilize a parameter, it might result
+ in a build warning. We advocate for utilizing static inline functions
+ to replace such macros.
+ For example, for a macro such as the one below::
+
+ #define test(a) do { } while (0)
+
+ there would be a warning like below::
+
+ WARNING: Argument 'a' is not used in function-like macro.
+
+ See: https://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtl
+
**SINGLE_STATEMENT_DO_WHILE_MACRO**
For the multi-statement macros, it is necessary to use the do-while
loop to avoid unpredictable code paths. The do-while loop helps to