2014-10-21 17:06:55

by Fabio Estevam

Subject: [PATCH] checkpatch: Improve warning message for "needless if" case

Break the sentence so that it looks better:

WARNING: debugfs_remove(NULL) is safe. This check is probably not required

Signed-off-by: Fabio Estevam <[email protected]>
---
scripts/checkpatch.pl | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index d94f5d8..99653bb 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -4446,7 +4446,7 @@ sub process {
my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
WARN('NEEDLESS_IF',
- "$1(NULL) is safe this check is probably not required\n" . $hereprev);
+ "$1(NULL) is safe. This check is probably not required\n" . $hereprev);
}
}

--
1.9.1

2014-10-21 16:40:16

by Joe Perches

Subject: Re: [PATCH] checkpatch: Improve warning message for "needless if" case

On Tue, 2014-10-21 at 12:33 -0200, Fabio Estevam wrote:
> Break the sentence so that it looks better:
>
> WARNING: debugfs_remove(NULL) is safe. This check is probably not required
[]
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -4446,7 +4446,7 @@ sub process {
> my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
> if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
> WARN('NEEDLESS_IF',
> - "$1(NULL) is safe this check is probably not required\n" . $hereprev);
> + "$1(NULL) is safe. This check is probably not required\n" . $hereprev);
> }
> }
>

Mixing sentences with and without periods is jarring.
I'd prefer a comma or a dash.

2014-10-21 16:44:07

by Fabio Estevam

Subject: Re: [PATCH] checkpatch: Improve warning message for "needless if" case

On Tue, Oct 21, 2014 at 2:40 PM, Joe Perches <[email protected]> wrote:

>
> Mixing sentences with and without periods is jarring.
> I'd prefer a comma or a dash.

Or what about?

"is safe and this check is probably not required"

2014-10-21 16:51:25

by Joe Perches

Subject: Re: [PATCH] checkpatch: Improve warning message for "needless if" case

On Tue, 2014-10-21 at 14:44 -0200, Fabio Estevam wrote:
> On Tue, Oct 21, 2014 at 2:40 PM, Joe Perches <[email protected]> wrote:
>
> >
> > Mixing sentences with and without periods is jarring.
> > I'd prefer a comma or a dash.
>
> Or what about?
>
> "is safe and this check is probably not required"

That'd be fine too