* [PATCH] Documentation: checkpatch: Add TRAILING_SEMICOLON message
@ 2021-09-04 7:42 Utkarsh Verma
2021-09-14 21:07 ` Jonathan Corbet
0 siblings, 1 reply; 2+ messages in thread
From: Utkarsh Verma @ 2021-09-04 7:42 UTC (permalink / raw)
To: Dwaipayan Ray
Cc: Lukas Bulwahn, Joe Perches, Jonathan Corbet, linux-doc,
linux-kernel, Utkarsh Verma
Add a new message type TRAILING_SEMICOLON for the macro definitions
that conclude with a semicolon.
Suggested-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Signed-off-by: Utkarsh Verma <utkarshverma294@gmail.com>
---
Documentation/dev-tools/checkpatch.rst | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
index f0956e9ea2d8..30eda8f4a8bd 100644
--- a/Documentation/dev-tools/checkpatch.rst
+++ b/Documentation/dev-tools/checkpatch.rst
@@ -845,6 +845,27 @@ Macros, Attributes and Symbols
Use the `fallthrough;` pseudo keyword instead of
`/* fallthrough */` like comments.
+ **TRAILING_SEMICOLON**
+ Macro definition should not end with a semicolon. The macro
+ invocation style should be consistent with function calls.
+ This can prevent any unexpected code paths::
+
+ #define MAC do_something;
+
+ If this macro is used within a if else statement, like::
+
+ if (some_condition)
+ MAC;
+
+ else
+ do_something;
+
+ Then there would be a compilation error, because when the macro is
+ expanded there are two trailing semicolons, so the else branch gets
+ orphaned.
+
+ See: https://lore.kernel.org/lkml/1399671106.2912.21.camel@joe-AO725/
+
**WEAK_DECLARATION**
Using weak declarations like __attribute__((weak)) or __weak
can have unintended link defects. Avoid using them.
--
2.25.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] Documentation: checkpatch: Add TRAILING_SEMICOLON message
2021-09-04 7:42 [PATCH] Documentation: checkpatch: Add TRAILING_SEMICOLON message Utkarsh Verma
@ 2021-09-14 21:07 ` Jonathan Corbet
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2021-09-14 21:07 UTC (permalink / raw)
To: Utkarsh Verma, Dwaipayan Ray
Cc: Lukas Bulwahn, Joe Perches, linux-doc, linux-kernel, Utkarsh Verma
Utkarsh Verma <utkarshverma294@gmail.com> writes:
> Add a new message type TRAILING_SEMICOLON for the macro definitions
> that conclude with a semicolon.
>
> Suggested-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
> Signed-off-by: Utkarsh Verma <utkarshverma294@gmail.com>
> ---
> Documentation/dev-tools/checkpatch.rst | 21 +++++++++++++++++++++
> 1 file changed, 21 insertions(+)
Applied, thanks.
jon
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-09-14 21:08 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-09-04 7:42 [PATCH] Documentation: checkpatch: Add TRAILING_SEMICOLON message Utkarsh Verma
2021-09-14 21:07 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).