From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-11.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,NICE_REPLY_A, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,USER_AGENT_SANE_1 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 813D7C433E2 for ; Wed, 2 Sep 2020 16:43:57 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 4DF6720684 for ; Wed, 2 Sep 2020 16:43:57 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 4DF6720684 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=suse.de Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:49864 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kDVrY-0001sA-Hn for qemu-devel@archiver.kernel.org; Wed, 02 Sep 2020 12:43:56 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:39708) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kDVoK-0007Sq-5o for qemu-devel@nongnu.org; Wed, 02 Sep 2020 12:40:37 -0400 Received: from mx2.suse.de ([195.135.220.15]:57452) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kDVoH-0005vc-Hj for qemu-devel@nongnu.org; Wed, 02 Sep 2020 12:40:35 -0400 X-Virus-Scanned: by amavisd-new at test-mx.suse.de Received: from relay2.suse.de (unknown [195.135.221.27]) by mx2.suse.de (Postfix) with ESMTP id E7F4BAC79; Wed, 2 Sep 2020 16:40:30 +0000 (UTC) Subject: Re: [RFC v2] checkpatch: detect missing changes to trace-events To: Markus Armbruster References: <20200807111447.15599-1-cfontana@suse.de> <87sgc06wj1.fsf@dusky.pond.sub.org> From: Claudio Fontana Message-ID: <2f13b0e6-72f9-df8b-f3cb-e520140b6b22@suse.de> Date: Wed, 2 Sep 2020 18:40:29 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.11.0 MIME-Version: 1.0 In-Reply-To: <87sgc06wj1.fsf@dusky.pond.sub.org> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit Received-SPF: pass client-ip=195.135.220.15; envelope-from=cfontana@suse.de; helo=mx2.suse.de X-detected-operating-system: by eggs.gnu.org: First seen = 2020/09/01 00:13:10 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x (no timestamps) [generic] X-Spam_score_int: -44 X-Spam_score: -4.5 X-Spam_bar: ---- X-Spam_report: (-4.5 / 5.0 requ) BAYES_00=-1.9, NICE_REPLY_A=-0.324, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: "Michael S . Tsirkin" , =?UTF-8?Q?Philippe_Mathieu-Daud=c3=a9?= , qemu-devel@nongnu.org, Stefan Hajnoczi , Paolo Bonzini , =?UTF-8?Q?Alex_Benn=c3=a9e?= Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" On 9/2/20 5:14 PM, Markus Armbruster wrote: > Claudio Fontana writes: > >> Signed-off-by: Claudio Fontana >> --- >> scripts/checkpatch.pl | 37 ++++++++++++++++++++++++++++++------- >> 1 file changed, 30 insertions(+), 7 deletions(-) >> >> v1 -> v2 : >> >> * track the "from" file in addition to the "to" file, >> and grep into both (if they exist), looking for trace.h, trace-root.h >> >> If files are reachable and readable, emit a warning if there is no >> update to trace-events. >> >> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl >> index bd3faa154c..37db212fc6 100755 >> --- a/scripts/checkpatch.pl >> +++ b/scripts/checkpatch.pl >> @@ -1300,6 +1300,7 @@ sub process { >> my $in_header_lines = $file ? 0 : 1; >> my $in_commit_log = 0; #Scanning lines before patch >> my $reported_maintainer_file = 0; >> + my $reported_trace_events_file = 0; >> my $non_utf8_charset = 0; >> >> our @report = (); >> @@ -1309,6 +1310,7 @@ sub process { >> our $cnt_chk = 0; >> >> # Trace the real file/line as we go. >> + my $fromfile = ''; >> my $realfile = ''; >> my $realline = 0; >> my $realcnt = 0; >> @@ -1454,10 +1456,15 @@ sub process { >> $here = "#$realline: " if ($file); >> >> # extract the filename as it passes >> - if ($line =~ /^diff --git.*?(\S+)$/) { >> - $realfile = $1; >> - $realfile =~ s@^([^/]*)/@@ if (!$file); >> + if ($line =~ /^diff --git.*?(\S+).*?(\S+)$/) { >> + $fromfile = $1; >> + $realfile = $2; >> + if (!$file) { >> + $fromfile =~ s@^([^/]*)/@@ ; >> + $realfile =~ s@^([^/]*)/@@ ; >> + } >> checkfilename($realfile, \$acpi_testexpected, \$acpi_nontestexpected); >> + > > Drop this blank line. > >> } elsif ($line =~ /^\+\+\+\s+(\S+)/) { >> $realfile = $1; >> $realfile =~ s@^([^/]*)/@@ if (!$file); >> @@ -1470,6 +1477,11 @@ sub process { >> } >> >> next; >> + > > And this one. > >> + } elsif ($line =~ /^---\s+(\S+)/) { >> + $fromfile = $1; >> + $fromfile =~ s@^([^/]*)/@@ if (!$file); >> + next; >> } >> >> $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); > > Aside: I don't understand why we need to match both the diff line and > the --- line (and now the +++ line, too). > >> @@ -1524,15 +1536,26 @@ sub process { >> if ($line =~ /^\s*MAINTAINERS\s*\|/) { >> $reported_maintainer_file = 1; >> } >> - >> +# similar check for trace-events >> + if ($line =~ /^\s*trace-events\s*\|/) { >> + $reported_trace_events_file = 1; >> + } > > These are meant to match in the diffstat (took me a stare to figure that > out). > > The existing one matches MAINTAINERS in the source root. Good; that's > where it is. > > The new one matches trace-events in the source root. Not so good; We > use one trace-events per directory. > > If I update trace-events in the source root, I won't be warned about > other trace-events in need of updating (false negative), will I? > > If I don't update trace-events in the source root, I will be warned > regardless of what other trace-events I update (false positive), won't > I? > >> # Check for added, moved or deleted files >> - if (!$reported_maintainer_file && !$in_commit_log && >> + if (!$in_commit_log && >> ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || >> $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || >> ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && >> (defined($1) || defined($2))))) { >> - $reported_maintainer_file = 1; >> - WARN("added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); >> + if (!$reported_maintainer_file) { >> + $reported_maintainer_file = 1; >> + WARN("added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); >> + } >> + if (!$reported_trace_events_file) { >> + if (`grep -F -s -e trace.h -e trace-root.h ${fromfile} ${realfile}` ne '') { >> + $reported_trace_events_file = 1; >> + WARN("added, moved or deleted file(s), does trace-events need updating?\n" . $herecurr); >> + } >> + } >> } >> >> # Check for wrappage within a valid hunk of the file > > Regarding Stefan's observations: > > * Yes, the grep patterns need tightening. > > * Yes, forking grep could be replaced by a simple function that slurps > in the file and searches it. Could doesn't imply should, let alome > must. > > As discussed in review of v1, I'm not sure checkpatch.pl is the best > home for this kind of check. I'm not going to reject a working patch > because of that. > Hi Marcus, I will rethink this in the future, thanks for the useful feedback, but I think this needs to be rethought, reworked and tested more. Thanks! Claudio