[v2] coccinelle: api/atomic_as_refcounter: include message type in output

Message ID Y6mIQIubjvg7aX11@qemulion
State New
Headers
Series [v2] coccinelle: api/atomic_as_refcounter: include message type in output |

Commit Message

Deepak R Varma Dec. 26, 2022, 11:40 a.m. UTC
  A common practice is to grep for "WARNING" or "ERROR" text in the report
output from a Coccinelle semantic patch script. So, include the text
"WARNING: " in the report output generated by the semantic patch for
desired filtering of the output. Also improves the readability of the
output. Here is an example of the old and new outputs reported:

    xyz_file.c:131:39-40: atomic_add_unless
    xyz_file.c:131:39-40: WARNING: atomic_add_unless

    xyz_file.c:196:6-25: atomic_dec_and_test variation before object free at line 208.
    xyz_file.c:196:6-25: WARNING: atomic_dec_and_test variation before object free at line 208.

Signed-off-by: Deepak R Varma <drv@mailo.com>
---

Changes in v2:
   1. Correct word test to text in patch description. Feedback from Markus.Elfring@web.de


 scripts/coccinelle/api/atomic_as_refcounter.cocci | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

--
2.34.1
  

Comments

Julia Lawall Dec. 26, 2022, 8:51 p.m. UTC | #1
On Mon, 26 Dec 2022, Deepak R Varma wrote:

> A common practice is to grep for "WARNING" or "ERROR" text in the report
> output from a Coccinelle semantic patch script. So, include the text
> "WARNING: " in the report output generated by the semantic patch for
> desired filtering of the output. Also improves the readability of the
> output. Here is an example of the old and new outputs reported:
>
>     xyz_file.c:131:39-40: atomic_add_unless
>     xyz_file.c:131:39-40: WARNING: atomic_add_unless
>
>     xyz_file.c:196:6-25: atomic_dec_and_test variation before object free at line 208.
>     xyz_file.c:196:6-25: WARNING: atomic_dec_and_test variation before object free at line 208.
>
> Signed-off-by: Deepak R Varma <drv@mailo.com>

Applied, thanks.

> ---
>
> Changes in v2:
>    1. Correct word test to text in patch description. Feedback from Markus.Elfring@web.de
>
>
>  scripts/coccinelle/api/atomic_as_refcounter.cocci | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/scripts/coccinelle/api/atomic_as_refcounter.cocci b/scripts/coccinelle/api/atomic_as_refcounter.cocci
> index e63d52408b86..bbe5b2932933 100644
> --- a/scripts/coccinelle/api/atomic_as_refcounter.cocci
> +++ b/scripts/coccinelle/api/atomic_as_refcounter.cocci
> @@ -55,7 +55,7 @@ identifier fname6 =~ ".*call_rcu.*";
>  p1 << r1.p1;
>  p2 << r1.p2;
>  @@
> -msg = "atomic_dec_and_test variation before object free at line %s."
> +msg = "WARNING: atomic_dec_and_test variation before object free at line %s."
>  coccilib.report.print_report(p1[0], msg % (p2[0].line))
>
>  @r4 exists@
> @@ -88,7 +88,7 @@ fname@p2(y, ...);
>  p1 << r4.p1;
>  p2 << r4.p2;
>  @@
> -msg = "atomic_dec_and_test variation before object free at line %s."
> +msg = "WARNING: atomic_dec_and_test variation before object free at line %s."
>  coccilib.report.print_report(p1[0], msg % (p2[0].line))
>
>  @r2 exists@
> @@ -107,7 +107,7 @@ atomic64_add_unless(&(a)->x,-1,1)@p1
>  @script:python depends on report@
>  p1 << r2.p1;
>  @@
> -msg = "atomic_add_unless"
> +msg = "WARNING: atomic_add_unless"
>  coccilib.report.print_report(p1[0], msg)
>
>  @r3 exists@
> @@ -126,5 +126,5 @@ x = atomic64_add_return@p1(-1, ...);
>  @script:python depends on report@
>  p1 << r3.p1;
>  @@
> -msg = "x = atomic_add_return(-1, ...)"
> +msg = "WARNING: x = atomic_add_return(-1, ...)"
>  coccilib.report.print_report(p1[0], msg)
> --
> 2.34.1
>
>
>
>
  

Patch

diff --git a/scripts/coccinelle/api/atomic_as_refcounter.cocci b/scripts/coccinelle/api/atomic_as_refcounter.cocci
index e63d52408b86..bbe5b2932933 100644
--- a/scripts/coccinelle/api/atomic_as_refcounter.cocci
+++ b/scripts/coccinelle/api/atomic_as_refcounter.cocci
@@ -55,7 +55,7 @@  identifier fname6 =~ ".*call_rcu.*";
 p1 << r1.p1;
 p2 << r1.p2;
 @@
-msg = "atomic_dec_and_test variation before object free at line %s."
+msg = "WARNING: atomic_dec_and_test variation before object free at line %s."
 coccilib.report.print_report(p1[0], msg % (p2[0].line))

 @r4 exists@
@@ -88,7 +88,7 @@  fname@p2(y, ...);
 p1 << r4.p1;
 p2 << r4.p2;
 @@
-msg = "atomic_dec_and_test variation before object free at line %s."
+msg = "WARNING: atomic_dec_and_test variation before object free at line %s."
 coccilib.report.print_report(p1[0], msg % (p2[0].line))

 @r2 exists@
@@ -107,7 +107,7 @@  atomic64_add_unless(&(a)->x,-1,1)@p1
 @script:python depends on report@
 p1 << r2.p1;
 @@
-msg = "atomic_add_unless"
+msg = "WARNING: atomic_add_unless"
 coccilib.report.print_report(p1[0], msg)

 @r3 exists@
@@ -126,5 +126,5 @@  x = atomic64_add_return@p1(-1, ...);
 @script:python depends on report@
 p1 << r3.p1;
 @@
-msg = "x = atomic_add_return(-1, ...)"
+msg = "WARNING: x = atomic_add_return(-1, ...)"
 coccilib.report.print_report(p1[0], msg)