lkml.org 
[lkml]   [2010]   [Mar]   [20]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH] checkpatch: Add check for too short Kconfig descriptions
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Am 2010-03-20 15:07 schrieb Andi Kleen:
> The warning merely is intended to get people to think
> about that. Yes it cannot enforce it directly.

Then change the wording, at least. With the current wording, people will
think, "But I did!", and complain about a false positive on LKML, where
they will be annoyed to learn that checkpatch.pl's criterion for
"describing fully" is "having at least four lines".

But even with a better wording, I think the warning will still do more
harm than good.

> Yes it's not a perfect measure and can be circumvented. But hopefully
> most users would not.

I'm not thinking of circumvention, but of well-meaning authors writing
long explanations that describe everything the author found worth
mentioning, but still don't answer the essential question: "Should I
select that option?" In fact, most of the unhelpful Kconfig help texts
I've encountered where longer than four lines. :-)

Thanks,
Tilman
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.12 (MingW32)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
iEYEARECAAYFAkulBN0ACgkQQ3+did9BuFtg4QCeNBnPAbMg3+dYfoimlG5/lQZ/
vRYAniohcXcoeC3+59eKSWwZ3B4fJ6Ix
=E5sA
-----END PGP SIGNATURE-----

\
 
 \ /
  Last update: 2010-03-20 18:27    [from the cache]
©2003-2011 Jasper Spaans. Advertise on this site