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=-9.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED 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 585A2C4363A for ; Mon, 5 Oct 2020 07:18:22 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 1639F20659 for ; Mon, 5 Oct 2020 07:18:22 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1725939AbgJEHSV (ORCPT ); Mon, 5 Oct 2020 03:18:21 -0400 Received: from smtprelay0023.hostedemail.com ([216.40.44.23]:58888 "EHLO smtprelay.hostedemail.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1725873AbgJEHSU (ORCPT ); Mon, 5 Oct 2020 03:18:20 -0400 Received: from filter.hostedemail.com (clb03-v110.bra.tucows.net [216.40.38.60]) by smtprelay05.hostedemail.com (Postfix) with ESMTP id 70A4F18029210; Mon, 5 Oct 2020 07:18:19 +0000 (UTC) X-Session-Marker: 6A6F6540706572636865732E636F6D X-HE-Tag: worm55_1211179271bc X-Filterd-Recvd-Size: 4609 Received: from XPS-9350.home (unknown [47.151.133.149]) (Authenticated sender: joe@perches.com) by omf15.hostedemail.com (Postfix) with ESMTPA; Mon, 5 Oct 2020 07:18:18 +0000 (UTC) Message-ID: Subject: Re: [PATCH RFC] checkpatch: add new warnings to author signoff checks. From: Joe Perches To: Dwaipayan Ray Cc: linux-kernel-mentees@lists.linuxfoundation.org, lukas.bulwahn@gmail.com, linux-kernel@vger.kernel.org Date: Mon, 05 Oct 2020 00:18:17 -0700 In-Reply-To: <20201005064842.33495-1-dwaipayanray1@gmail.com> References: <20201005064842.33495-1-dwaipayanray1@gmail.com> Content-Type: text/plain; charset="ISO-8859-1" User-Agent: Evolution 3.36.4-0ubuntu1 MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Mon, 2020-10-05 at 12:18 +0530, Dwaipayan Ray wrote: > The author signed-off-by checks are currently very vague. > Cases like same name or same address are not handled separately. > > For example, running checkpatch on commit be6577af0cef > ("parisc: Add atomic64_set_release() define to avoid CPU soft lockups"), > gives: > > WARNING: Missing Signed-off-by: line by nominal patch author > 'John David Anglin ' > > The signoff line was: > "Signed-off-by: Dave Anglin " > > Clearly the author has signed off but with a slightly different version > of his name. A more appropriate warning would have been to point out > at the name mismatch instead. > > Introduced three new types of warnings: > > 1) Address matches, but names are different. > "James Watson ", "James " > > 2) Name matches, but addresses are different. > "James Watson ", "James Watson " > > 3) Name matches, but addresses without mail extensions are same. > "James Watson ", "James Watson " > > For the 3rd class, a --strict check message is generated, and for the > other two, warnings are generated. I don't have any issue with the concept, but please be consistent with spacing after if tests. Always use a single space after if > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl > @@ -2347,6 +2347,7 @@ sub process { > my $signoff = 0; > my $author = ''; > my $authorsignoff = 0; > + my $authorsignoff_ctx = ''; ctx isn't a descriptive name. Maybe $author_sob > @@ -2674,9 +2675,34 @@ sub process { > if ($line =~ /^\s*signed-off-by:\s*(.*)/i) { > $signoff++; > $in_commit_log = 0; > - if ($author ne '') { > + if ($author ne '' && $authorsignoff != 1) { Has space after if > if (same_email_addresses($1, $author)) { > $authorsignoff = 1; > + } else { > + my $ctx = $1; > + my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx); > + my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author); > + > + if($email_address eq $author_address) { No space after if, etc... > @@ -6891,9 +6917,32 @@ sub process { > if ($signoff == 0) { > ERROR("MISSING_SIGN_OFF", > "Missing Signed-off-by: line(s)\n"); > - } elsif (!$authorsignoff) { > - WARN("NO_AUTHOR_SIGN_OFF", > - "Missing Signed-off-by: line by nominal patch author '$author'\n"); > + } elsif ($authorsignoff != 1) { > + # authorsignoff values: > + # 0 -> missing sign off > + # 1 -> sign off present sign off identical > + # 2 -> address matches, name different > + # 3 -> name matches, address different > + # 4 -> name matches, address matches without extension extension here isn't obvious > + > + my $ctx_msg = "'Signed-off-by: $authorsignoff_ctx' should be:\n'Signed-off-by: $author'"; New line not necessary or useful really. And for mismatches, it's really not known that it should be one way or the or the other is it? > + > + if($authorsignoff == 0) { > + WARN("NO_AUTHOR_SIGN_OFF", > + "Missing Signed-off-by: line by nominal patch author '$author'\n"); > + } > + elsif($authorsignoff == 2) { > + WARN("NO_AUTHOR_SIGN_OFF", > + "Author name mismatch:\n$ctx_msg\n"); > + } > + elsif($authorsignoff == 3) { > + WARN("NO_AUTHOR_SIGN_OFF", > + "Author address mismatch:\n$ctx_msg\n"); > + } > + elsif($authorsignoff == 4) { > + CHK("NO_AUTHOR_SIGN_OFF", > + "Author mail extension mismatch:\n$ctx_msg\n"); > + } > } > } >