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=-3.8 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=no 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 B4A39C4360C for ; Tue, 8 Oct 2019 18:25:19 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 9A54C2070B for ; Tue, 8 Oct 2019 18:25:19 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727677AbfJHSZS (ORCPT ); Tue, 8 Oct 2019 14:25:18 -0400 Received: from smtprelay0179.hostedemail.com ([216.40.44.179]:35115 "EHLO smtprelay.hostedemail.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1726098AbfJHSZS (ORCPT ); Tue, 8 Oct 2019 14:25:18 -0400 Received: from filter.hostedemail.com (clb03-v110.bra.tucows.net [216.40.38.60]) by smtprelay05.hostedemail.com (Postfix) with ESMTP id 617FB180366F8; Tue, 8 Oct 2019 18:25:16 +0000 (UTC) X-Session-Marker: 6A6F6540706572636865732E636F6D X-HE-Tag: bone25_10a92d541f841 X-Filterd-Recvd-Size: 5507 Received: from XPS-9350.home (unknown [47.151.152.152]) (Authenticated sender: joe@perches.com) by omf14.hostedemail.com (Postfix) with ESMTPA; Tue, 8 Oct 2019 18:25:14 +0000 (UTC) Message-ID: <18e4ecf36ada8a9a90cfb1e96bdb04bdbca4a537.camel@perches.com> Subject: Re: [PATCH] checkpatch: use patch subject when reading from stdin From: Joe Perches To: Geert Uytterhoeven Cc: Geert Uytterhoeven , Andy Whitcroft , Andrew Morton , Linux Kernel Mailing List Date: Tue, 08 Oct 2019 11:25:12 -0700 In-Reply-To: References: <20191008094006.8251-1-geert+renesas@glider.be> <19c54ca5b3750bebc057e20542ad6c0c2acef960.camel@perches.com> Content-Type: text/plain; charset="ISO-8859-1" User-Agent: Evolution 3.32.1-2 MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Tue, 2019-10-08 at 20:10 +0200, Geert Uytterhoeven wrote: > Hi Joe, > > On Tue, Oct 8, 2019 at 7:02 PM Joe Perches wrote: > > On Tue, 2019-10-08 at 17:28 +0200, Geert Uytterhoeven wrote: > > > On Tue, Oct 8, 2019 at 5:20 PM Joe Perches wrote: > > > > On Tue, 2019-10-08 at 11:40 +0200, Geert Uytterhoeven wrote: > > > > > When reading a patch file from standard input, checkpatch calls it "Your > > > > > patch", and reports its state as: > > > > > > > > > > Your patch has style problems, please review. > > > > > > > > > > or: > > > > > > > > > > Your patch has no obvious style problems and is ready for submission. > > > > > > > > > > Hence when checking multiple patches by piping them to checkpatch, e.g. > > > > > when checking patchwork bundles using: > > > > > > > > > > formail -s scripts/checkpatch.pl < bundle-foo.mbox > > > > > > > > > > it is difficult to identify which patches need to be reviewed and > > > > > improved. > > > > > > > > > > Fix this by replacing "Your patch" by the patch subject, if present. > > > > [] > > > > > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl > > > > [] > > > > > @@ -1047,6 +1047,10 @@ for my $filename (@ARGV) { > > > > > } > > > > > while (<$FILE>) { > > > > > chomp; > > > > > + if ($vname eq 'Your patch') { > > > > > + my ($subject) = $_ =~ /^Subject:\s*(.*)/; > > > > > + $vname = '"' . $subject . '"' if $subject; > > > > > > > > Hi again Geert. > > > > > > > > Just some stylistic nits: > > > > > > > > $filename is not quoted so I think adding quotes > > > > before and after $subject may not be useful. > > > > > > Filename is indeed not quoted, but $git_commits{$filename} is. > > > > If I understand your use case, this will only show the last > > patch $subject of a bundle? > > False. Not really false, it's true. Your use case just doesn't submit bundled patches as a single input to checkpatch. > "formail -s scripts/checkpatch.pl < bundle-foo.mbox" splits > "bundle-foo.mbox" in separate patches, and invokes > "scripts/checkpatch.pl" for each of them. Never used formail, it seems it was last updated in 2001. > > Also, it'll show things like "duplicate signature" when multiple > > patches are tested in a single bundle. > > False, due to the splitting by formail. Again, not false, just not your use. > > For instance, if I have a git format-patch series in an output > > directory and do > > > > $ cat /*.patch | ./scripts/checkpatch.pl > > > > Bad output happen. > > Yeah, because you're concatenating all patches. > Currently it works for single patches only. > > > Maybe this might be better: > > --- a/scripts/checkpatch.pl > > +++ b/scripts/checkpatch.pl > > @@ -2444,6 +2444,15 @@ sub process { > > > > my $rawline = $rawlines[$linenr - 1]; > > > > +# if input from stdin, report the subject lines if they exist > > + if ($filename eq '-' && !$quiet && > > + $rawline =~ /^Subject:\s*(.*)/) { > > + report("stdin", "STDIN", '-' x length($1)); > > + report("stdin", "STDIN", $1); > > + report("stdin", "STDIN", '-' x length($1)); > > + %signatures = (); # avoid duplicate signatures > > + } > > + > > # check if it's a mode change, rename or start of a patch > > if (!$in_commit_log && > > ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || > > Perhaps. Just passing the patchwork bundle to checkpatch, and fixing > checkpatch to handle multiple patches in a single file was my first idea. > But it looked fragile, with too much state that needs to be reset. > I.e. the state is not limited to %signatures. You also have to reset > $author inside process(), and probably a dozen other variables. > And make sure that future changes don't forget resetting all newly > introduced variables. > > Hence I settled for the solution using formail. I still think the patch I suggested is better as it functions for other use cases too.