Skip to contentSkip to conversation

git pre-commit hook running checkpatch.pl

DISCUSSION Ben Dooks 4 participants 4 messages Jan 20, 2010 Arm Samsung Exynos

lore
Share & tools
lore

Ben Dooks

author
#0 lore raw

I've written a git pre-commit[1] hook which stops any commits happening if checkpatch.pl reports problems with the patch. Any comments?

[1] http://www.fluff.org/ben/linux/githooks/pre-commit

Signature · 12 lines
Ben

Q:      What's a light-year?
A:      One-third less calories than a regular year.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <http://lists.infradead.org/pipermail/linux-arm-kernel/attachments/20100120/e12ebdf8/attachment.sig>
#1 lore raw
Quoted 2 lines · Ben Dooks

I've written a git pre-commit[1] hook which stops any commits happening if checkpatch.pl reports problems with the patch. Any comments?

Very bad - checkpatch can be wrong at times.

Eg 1, asm/irq.h vs linux/irq.h
Eg 2, asm/memory.h vs linux/memory.h
Eg 3, lines longer than 80 characters for printk() strings are preferred
so that they are grep-able.

checkpatch is at best a guide, not a set of hard rules.

#2 lore raw
In reply to Ben Dooks
Quoted 4 lines · Ben Dooks

I've written a git pre-commit[1] hook which stops any commits happening if checkpatch.pl reports problems with the patch. Any comments?

[1] http://www.fluff.org/ben/linux/githooks/pre-commit

Checkpatch does sometimes generate the occasional false positive which can be annoying when they trigger. It can also be a problem when doing bugfixes IME - if an existing file has lots of checkpatch issues then a fix which maintains the same coding style as the surrounding code can trigger checkpatch issues which would if fixed make the code not fit in with the rest of the file. Obviously it'd be desirable to fix the file but that's a bit unreasonable for people submitting bug fixes, especially when pushing fixes to Linus and stable.

That said, monitoring for checkpatch issues is useful.

#3 lore raw
Quoted 16 lines · Mark Brown
Quoted 4 lines · Ben Dooks

I've written a git pre-commit[1] hook which stops any commits happening if checkpatch.pl reports problems with the patch. Any comments?

[1] http://www.fluff.org/ben/linux/githooks/pre-commit

Checkpatch does sometimes generate the occasional false positive which can be annoying when they trigger. It can also be a problem when doing bugfixes IME - if an existing file has lots of checkpatch issues then a fix which maintains the same coding style as the surrounding code can trigger checkpatch issues which would if fixed make the code not fit in with the rest of the file. Obviously it'd be desirable to fix the file but that's a bit unreasonable for people submitting bug fixes, especially when pushing fixes to Linus and stable.

Quoted 1 line

That said, monitoring for checkpatch issues is useful.

Maybe only print the warnings instead of stopping a commit? I'd not like me stopping here not only for the reasons pointed out by Mark and Russell, but also as I frequently do wip-commits that not necessarily are checkpatch-clean.

Best regards
Uwe

Signature · 2 lines
Pengutronix e.K.                              | Uwe Kleine-K?nig            |
Industrial Linux Solutions                    | http://www.pengutronix.de/  |