Re: [PATCH] checkpatch: Add check for too short Kconfig descriptions

[Andi Kleen]

On Sat, Mar 20, 2010 at 02:31:30PM +0100, Tilman Schmidt wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
> 
> Am 2010-03-20 03:32 schrieb Andi Kleen:
> >     I've seen various new Kconfigs with rather unhelpful one liner
> >     descriptions. Add a Kconfig warning for a minimum length of the
> >     Kconfig help section.
> 
> I don't think helpfulness can be enforced via line count.

The warning merely is intended to get people to think
about that. Yes it cannot enforce it directly.

> A one-liner can be quite sufficient (eg. CRYPTO_MD4).

I don't think that one liner is sufficient. Consider the stand point
of someone who doesn't know anything of cryptography. They will
need at least one or two sentences to decided if they need
that option not.

Yes it will likely lead to some duplicate descriptions, but that's not
a problem. In fact it's a feature because it makes the job of
the person setting that option easier.

> OTOH more lines can still leave important questions unanswered (eg.
> CRYPTO_SALSA20_586 whose help text is identical to that of
> CRYPTO_SALSA20, leaving you wondering when to choose one over the other).

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

-Andi

-- 
ak@xxxxxxxxxxxxxxx -- Speaking for myself only.
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/