public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Jean Delvare <jdelvare@suse.de>
To: Andy Whitcroft <apw@canonical.com>, Joe Perches <joe@perches.com>
Cc: LKML <linux-kernel@vger.kernel.org>
Subject: checkpatch on Kconfig files
Date: Fri, 21 Mar 2014 09:42:39 +0100	[thread overview]
Message-ID: <20140321094239.18aebf02@endymion.delvare> (raw)

Hi Andy, hi Joe,

When running checkpatch on a patch which tweaks many Kconfig entries, I
got the following output:

WARNING: please write a paragraph that describes the config symbol fully
#74: FILE: drivers/hid/Kconfig:142:
 config HID_BELKIN

WARNING: please write a paragraph that describes the config symbol fully
#82: FILE: drivers/hid/Kconfig:149:
 config HID_CHERRY

WARNING: please write a paragraph that describes the config symbol fully
#135: FILE: drivers/hid/Kconfig:415:
 config HID_MICROSOFT

total: 0 errors, 3 warnings, 88 lines checked

I am not adding these entries, just tweaking the dependencies. Thus I
don't think it makes sense to print these warnings, they aren't
relevant to the changes I am making. There comment in checkpatch says:

# check for Kconfig help text having a real description
# Only applies when adding the entry originally, after that we do not have
# sufficient context to determine whether it is indeed long enough.

So I suspect these warnings aren't supposed to be displayed. I recall
hitting this many times in the past, in fact I think this is the most
frequent and oldest false positive I get from checkpatch. So I would
appreciate if this could be fixed, either by really limiting the
warning to Kconfig entries being added (if you can) or by dropping the
check altogether (if you can't.)

Thanks,
-- 
Jean Delvare
SUSE L3 Support

             reply	other threads:[~2014-03-21  8:42 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-03-21  8:42 Jean Delvare [this message]
2014-03-21  8:57 ` checkpatch on Kconfig files Joe Perches
2014-03-21 13:21   ` Andi Kleen
2014-03-21 13:36     ` Jean Delvare
2014-03-21 15:18       ` Joe Perches
2014-03-21 16:11 ` Guenter Roeck

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=20140321094239.18aebf02@endymion.delvare \
    --to=jdelvare@suse.de \
    --cc=apw@canonical.com \
    --cc=joe@perches.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