Skip to contentSkip to conversation

Coccinelle: Script to drop parenthesis in the return statements

PATCH In review Himangi Saraogi 3 participants 5 messages Jun 19, 2014 – Jun 20, 2014 Coccinelle/Semantic Patches (SmPL)

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Coccinelle: Script to drop parenthesis in the return statements

This script detects the use of a parenthesis around return value ot the return statements and removes them as they are unnecessary and against the CodingStyle. A new directory called checkpatch is added for semantic patches that just make patches for what checkpatch does. This will help developers having checkpatch problems, to run the semantic patches in this directory on their code and fix some of them automatically.

---
 .../coccinelle/checkpatch/drop_parenthesis.cocci   | 33 ++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 scripts/coccinelle/checkpatch/drop_parenthesis.cocci
scripts/coccinelle/checkpatch/drop_parenthesis.cocci new file +32 -0
new file mode 100644
index 0000000..49c0538
@@ -0,0 +1,33 @@
+/// Remove parenthesis around return value in return statements
+///
+//# This makes an effort to find cases of parenthesis in the return
+//# statements when returning an identifier or a constant and removes
+//# the parenthesis as they are not required.
+//
+// Confidence: High
+// Copyright: 2014, Himangi Saraogi  GPLv2.
+// Comments:
+// Options: --no-includes --include-headers
+//
+
+virtual patch
+
+//----------------------------------------------------------
+//  For patch mode
+//----------------------------------------------------------
+
+ at depends on patch disable paren@
+identifier a;
+constant C;
+@@
+ return
+-(
+(
+C
+|
+a
+)
+-)
+ ;
+
Signature · 1 line
1.9.1
#1 lore raw
Quoted 6 lines · Himangi Saraogi

This script detects the use of a parenthesis around return value ot the return statements and removes them as they are unnecessary and against the CodingStyle. A new directory called checkpatch is added for semantic patches that just make patches for what checkpatch does. This will help developers having checkpatch problems, to run the semantic patches in this directory on their code and fix some of them automatically.

checkpatch already has --fix and --fix-inplace options that do something similar.

#2 lore raw
Quoted 10 lines · Joe Perches
Quoted 6 lines · Himangi Saraogi

This script detects the use of a parenthesis around return value ot the return statements and removes them as they are unnecessary and against the CodingStyle. A new directory called checkpatch is added for semantic patches that just make patches for what checkpatch does. This will help developers having checkpatch problems, to run the semantic patches in this directory on their code and fix some of them automatically.

checkpatch already has --fix and --fix-inplace options that do something similar.

OK. Then it is not worth adding coccinelle scripts for simple changes like this one.

I guess that some of the more complex changes, like choosing an appropriate error message function, checkpatch does not do?

julia

#3 lore raw
Quoted 9 lines · Julia Lawall
Quoted 8 lines · Joe Perches
Quoted 6 lines · Himangi Saraogi

This script detects the use of a parenthesis around return value ot the return statements and removes them as they are unnecessary and against the CodingStyle. A new directory called checkpatch is added for semantic patches that just make patches for what checkpatch does. This will help developers having checkpatch problems, to run the semantic patches in this directory on their code and fix some of them automatically.

Quoted 8 lines
Quoted 2 lines

checkpatch already has --fix and --fix-inplace options that do something similar.

OK. Then it is not worth adding coccinelle scripts for simple changes like this one.

I guess that some of the more complex changes, like choosing an appropriate error message function, checkpatch does not do?

I'm not quite sure what you're suggesting.

You mean choosing pr_err vs pr_notice or something like finding an active struct <foo> and converting printks to <foo>_<level>(&foo, fmt, ...)

from:

{
	struct device *dev;
	...
	printk(KERN_ERR "msg", ...)
to:
	dev_err(dev, "msg", ...)

checkpatch definitely can not do that.

Is it something else?

#4 lore raw
Quoted 33 lines · Joe Perches
Quoted 9 lines · Julia Lawall
Quoted 8 lines · Joe Perches
Quoted 6 lines · Himangi Saraogi

This script detects the use of a parenthesis around return value ot the return statements and removes them as they are unnecessary and against the CodingStyle. A new directory called checkpatch is added for semantic patches that just make patches for what checkpatch does. This will help developers having checkpatch problems, to run the semantic patches in this directory on their code and fix some of them automatically.

Quoted 8 lines
Quoted 2 lines

checkpatch already has --fix and --fix-inplace options that do something similar.

OK. Then it is not worth adding coccinelle scripts for simple changes like this one.

I guess that some of the more complex changes, like choosing an appropriate error message function, checkpatch does not do?

I'm not quite sure what you're suggesting.

You mean choosing pr_err vs pr_notice or something like finding an active struct <foo> and converting printks to <foo>_<level>(&foo, fmt, ...)

from:

{
	struct device *dev;
	...
	printk(KERN_ERR "msg", ...)
to:
	dev_err(dev, "msg", ...)
Quoted 3 lines

checkpatch definitely can not do that.

Is it something else?

Yes, that is what I was thinking of. Anyway, we can just test whether checkpatch --fix can d the change before proposing a semantic patch for it.

julia