From: Kalle Valo <kvalo@codeaurora.org>
To: Joe Perches <joe@perches.com>
Cc: "Levin\, Alexander" <alexander.levin@verizon.com>,
Sasha Levin <levinsasha928@gmail.com>,
Greg KH <gregkh@linuxfoundation.org>,
LKML <linux-kernel@vger.kernel.org>,
"ksummit-discuss\@lists.linuxfoundation.org"
<ksummit-discuss@lists.linuxfoundation.org>
Subject: Re: checkkpatch (in)sanity ?
Date: Mon, 29 Aug 2016 21:01:06 +0300 [thread overview]
Message-ID: <87lgzfihel.fsf@kamboji.qca.qualcomm.com> (raw)
In-Reply-To: <1472473855.3425.18.camel@perches.com> (Joe Perches's message of "Mon, 29 Aug 2016 05:30:55 -0700")
Joe Perches <joe@perches.com> writes:
> On Mon, 2016-08-29 at 14:15 +0300, Kalle Valo wrote:
>> I wish that checkpatch would have a way to enable/disable warnings per
>> directory (or file). For example, there would be
>> drivers/net/wireless/ath/ath10k/.checkpatch which would disable the
>> warnings are not suitable for ath10k for one reason or another:
>>
>> 'MSLEEP',
>> 'USLEEP_RANGE',
>> 'PRINTK_WITHOUT_KERN_LEVEL',
>> 'NETWORKING_BLOCK_COMMENT_STYLE',
>> 'BLOCK_COMMENT_STYLE',
>> 'LINUX_VERSION_CODE',
>> 'COMPLEX_MACRO',
>> 'PREFER_DEV_LEVEL',
>> 'PREFER_PR_LEVEL',
>> 'COMPARISON_TO_NULL',
>> 'BIT_MACRO',
>> 'CONSTANT_COMPARISON',
>> 'MACRO_WITH_FLOW_CONTROL'
>>
>> Currently my workaround is to have a custom ath10k-check script[1] which
>> runs checkpatch with those checks disabled. Oh, and it also filters out
>> some of the warnings based on the symbol it is located in.
>>
>> https://github.com/qca/qca-swiss-army-knife/blob/master/tools/scripts/ath10k/ath10k-check
>
> Hey Kalle:
>
> I looked at your script (which also does compilation
> and sparse checking) I don't see how a .checkpatch_conf
> hierarchy helps you much there as you've added all those
> long symbol name long line avoidance bits.
Yeah, it would not completely replace my script. But there's now quite a
difference with checkpatch parameters what other people use and what I
use.
> Also, there'd be a lot of rework to the globals in
> checkpatch for per-directory specific overrides if someone
> fed it files in multiple directories like
>
> checkpatch.pl <patchfile touching lib/kernel/include>
Oh, that's a good point. ath10k patches only touch one directory so I
didn't think of this.
> A couple btw's:
>
> Why avoid the printk, sleep or macro tests?
Actually I don't remember anymore :) I should have documented that in
the script.
(Runs some tests)
PRINTK_WITHOUT_KERN_LEVEL: I think I can enable this again, IIRC earlier
it gave useless warnings in ath10k_warn() & co.
MSLEEP: I think this is just noise, we don't care if it's actually 20 ms
even if ask for 10 ms. That's the minimum time to wait, not the maximum
(from our/HW point of view).
drivers/net/wireless/ath/ath10k/ahb.c:422: msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt
drivers/net/wireless/ath/ath10k/ahb.c:427: msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt
drivers/net/wireless/ath/ath10k/ahb.c:432: msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt
drivers/net/wireless/ath/ath10k/ahb.c:437: msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt
drivers/net/wireless/ath/ath10k/ahb.c:442: msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt
drivers/net/wireless/ath/ath10k/pci.c:2244: msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt
drivers/net/wireless/ath/ath10k/pci.c:2251: msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt
drivers/net/wireless/ath/ath10k/pci.c:2275: msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt
USLEEP_RANGE: I don't remember why I disabled this, most likely just
because of the msleep noise above
drivers/net/wireless/ath/ath10k/pci.c:2672: usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt
COMPLEX_MACRO: Can't remember this one either, I guess I just didn't
find a good solution to shut up checkpatch. But that was a long time
ago, it might be fixable now.
drivers/net/wireless/ath/ath10k/wmi.h:315: Macros with complex values should be enclosed in parentheses
drivers/net/wireless/ath/ath10k/wmi.h:6344: Macros with complex values should be enclosed in parentheses
BIT_MACRO: there's a lot of warnings from this one, the benefit from
changing all of them is questionable so I just disabled it.
drivers/net/wireless/ath/ath10k/rx_desc.h:676: Prefer using the BIT macro
> And this for ath10k_core_register_work:
>
> ('ath10k_core_register_work', 'RETURN_VOID'),
>
> and the code associated to it:
>
> err:
> /* TODO: It's probably a good idea to release device from the driver
> * but calling device_release_driver() here will cause a deadlock.
> */
> return;
> }
>
> ia avoided a few times in the kernel by using a bare ";"
> instead of "return;" before the function closing brace.
Heh, didn't know that.
> It's maybe unfortunate that gcc / c spec doesn't allow
> jumping to a label just before the function close brace.
Indeed.
I find checkpatch very useful to maintain certain coding style in ath10k
and I don't need to worry small details like whitespace. I just need to
disable some of the warnings so that they don't hide the real warnings
I'm interested about.
--
Kalle Valo
next prev parent reply other threads:[~2016-08-29 18:01 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-08-27 20:40 checkkpatch (in)sanity ? Joe Perches
2016-08-28 1:06 ` Levin, Alexander
2016-08-28 1:42 ` Joe Perches
2016-08-28 2:20 ` Joe Perches
2016-08-28 2:47 ` Levin, Alexander
2016-08-28 17:15 ` Joe Perches
2016-08-28 17:59 ` Greg KH
2016-08-28 22:37 ` Levin, Alexander
2016-08-28 23:20 ` Joe Perches
2016-08-29 2:22 ` Levin, Alexander
2016-08-29 8:20 ` Christoph Hellwig
2016-08-29 7:15 ` [Ksummit-discuss] " Alexandre Belloni
2016-08-29 9:01 ` Arnd Bergmann
2016-08-29 12:47 ` Joe Perches
2016-08-29 17:16 ` Josh Triplett
2016-08-29 17:41 ` Joe Perches
2016-08-29 17:46 ` Luck, Tony
2016-08-29 18:01 ` Joe Perches
2016-08-29 18:47 ` Joe Perches
2016-08-29 19:08 ` Josh Triplett
2016-08-29 21:07 ` Arnd Bergmann
2016-08-29 11:15 ` Kalle Valo
2016-08-29 12:30 ` Joe Perches
2016-08-29 18:01 ` Kalle Valo [this message]
2016-08-29 19:00 ` Joe Perches
2016-08-29 21:00 ` [Ksummit-discuss] " Arnd Bergmann
2016-08-28 7:56 ` Alexey Dobriyan
2016-08-28 9:59 ` Julia Lawall
2016-08-28 19:52 ` Joe Perches
2016-08-28 20:35 ` Jiri Kosina
2016-08-28 21:24 ` Dennis Kaarsemaker
2016-08-28 21:57 ` Joe Perches
2016-08-29 19:06 ` Dan Carpenter
2016-08-29 19:10 ` Josh Triplett
2016-08-29 19:17 ` Dan Carpenter
2016-08-29 19:34 ` Joe Perches
2016-08-29 19:21 ` Joe Perches
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87lgzfihel.fsf@kamboji.qca.qualcomm.com \
--to=kvalo@codeaurora.org \
--cc=alexander.levin@verizon.com \
--cc=gregkh@linuxfoundation.org \
--cc=joe@perches.com \
--cc=ksummit-discuss@lists.linuxfoundation.org \
--cc=levinsasha928@gmail.com \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).