From: Valentin Rothberg <valentinrothberg@gmail.com>
To: Michal Marek <mmarek@suse.cz>
Cc: linux-kernel@vger.kernel.org, akpm@linux-foundation.org,
linux-kbuild@vger.kernel.org, Paul Bolle <pebolle@tiscali.nl>,
Stefan Hengelein <stefan.hengelein@fau.de>
Subject: Re: [PATCH v8] checkkconfigsymbols.sh: reimplementation in python
Date: Sat, 4 Oct 2014 11:29:44 +0200 [thread overview]
Message-ID: <CAD3Xx4Kg82ugtN0RHOQNeDPW5Y7ymzm03NycmESztsVA4bJy8w@mail.gmail.com> (raw)
In-Reply-To: <542C1692.5060007@suse.cz>
On Wed, Oct 1, 2014 at 4:58 PM, Michal Marek <mmarek@suse.cz> wrote:
> On 2014-09-29 19:05, Valentin Rothberg wrote:
>> The scripts/checkkconfigsymbols.sh script searches Kconfig features
>> in the source code that are not defined in Kconfig. Such identifiers
>> always evaluate to false and are the source of various kinds of bugs.
>> However, the shell script is slow and it does not detect such broken
>> references in Kbuild and Kconfig files (e.g., ``depends on UNDEFINED´´).
>> Furthermore, it generates false positives. The script is also hard to
>> read and understand, and is thereby difficult to maintain.
>>
>> This patch replaces the shell script with an implementation in Python,
>> which:
>> (a) detects the same bugs, but does not report previous false positives
>> (b) additionally detects broken references in Kconfig and all
>> non-Kconfig files, such as Kbuild, .[cSh], .txt, .sh, defconfig, etc.
>> (c) is up to 75 times faster than the shell script
>> (d) only checks files under version control ('git ls-files')
>>
>> The new script reduces the runtime on my machine (i7-2620M, 8GB RAM, SSD)
>> from 3m47s to 0m3s, and reports 912 broken references in Linux v3.17-rc1;
>> 424 additional reports of which 16 are located in Kconfig files,
>> 287 in defconfigs, 63 in ./Documentation, 1 in Kbuild.
>>
>> Moreover, we intentionally include references in comments, which have been
>> ignored until now. Such comments may be leftovers of features that have
>> been removed or renamed in Kconfig (e.g., ``#endif /* CONFIG_MPC52xx */´´).
>> These references can be misleading and should be removed or replaced.
>>
>> Note that the output format changed from (file list <tab> feature) to
>> (feature <tab> file list) as it simplifies the detection of the Kconfig
>> feature for long file lists.
>>
>> Signed-off-by: Valentin Rothberg <valentinrothberg@gmail.com>
>> Signed-off-by: Stefan Hengelein <stefan.hengelein@fau.de>
>> Acked-by: Paul Bolle <pebolle@tiscali.nl>
>> ---
>> Changelog:
>> v2: Fix of regular expressions
>> v3: Changelog replacement, and add changes of v2
>> v4: Based on comments from Paul Bolle <pebolle@tiscali.nl>
>> - Inclusion of all non-Kconfig files, such as .txt, .sh, etc.
>> - Changes of regular expressions
>> - Increases additional reports from 49 to 229 compared to v3
>> - Change of output format from (file list <tab> feature) to
>> (feature <tab> file list)
>> v5: Only analyze files under version control ('git ls-files')
>> v6: Cover features with numbers and small letters (e.g., 4xx)
>> v7: Add changes of v6 (lost 'git add') and filter FOO/BAR features
>> v8: Based on comments from Paul Bolle <pebolle@tiscali.nl>
>> - Fix of [D]{,1}CONFIG_ regex to exclude false positives
>> - Exclude ".log" files of analysis
>> - Filter "XXX" feature
>> ---
>> scripts/checkkconfigsymbols.py | 139 +++++++++++++++++++++++++++++++++++++++++
>> scripts/checkkconfigsymbols.sh | 59 -----------------
>> 2 files changed, 139 insertions(+), 59 deletions(-)
>> create mode 100644 scripts/checkkconfigsymbols.py
>> delete mode 100755 scripts/checkkconfigsymbols.sh
>
> Please make the new file executable as well.
>
>
>> + for gitfile in stdout.rsplit("\n"):
>> + if ".git" in gitfile or "ChangeLog" in gitfile or \
>> + ".log" in gitfile or os.path.isdir(gitfile):
>> + continue
>
> Can you also skip arch/*/configs? A significant part of the output are
> defconfig files, but there is little value in reporting them. The stale
> options will go away automatically as soon as the defconfig is refreshed.
What do you mean by "refreshed"? And how often are they refreshed? I
think that reporting defconfigs helps to point to a problem, namely
that features are just not present anymore.
Thanks,
Valentin
next prev parent reply other threads:[~2014-10-04 9:30 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <1411222524-7850-1-git-send-email-valentinrothberg@gmail.com>
[not found] ` <1411919729-5800-1-git-send-email-valentinrothberg@gmail.com>
2014-09-29 10:28 ` [PATCH v7] checkkconfigsymbols.sh: reimplementation in python Paul Bolle
2014-09-29 12:08 ` Valentin Rothberg
2014-09-29 12:45 ` Paul Bolle
2014-09-29 14:47 ` Michal Marek
2014-09-29 16:21 ` Paul Bolle
2014-09-29 17:05 ` [PATCH v8] " Valentin Rothberg
2014-10-01 14:58 ` Michal Marek
2014-10-04 9:29 ` Valentin Rothberg [this message]
2014-10-08 13:39 ` Michal Marek
2014-10-19 15:30 ` Valentin Rothberg
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=CAD3Xx4Kg82ugtN0RHOQNeDPW5Y7ymzm03NycmESztsVA4bJy8w@mail.gmail.com \
--to=valentinrothberg@gmail.com \
--cc=akpm@linux-foundation.org \
--cc=linux-kbuild@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mmarek@suse.cz \
--cc=pebolle@tiscali.nl \
--cc=stefan.hengelein@fau.de \
/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).