Re: [PATCH v2] checkpatch: Warn if missing author Signed-off-by

[Geert Uytterhoeven]

Hi Joe,

On Wed, Jul 11, 2018 at 6:20 PM Joe Perches <joe@xxxxxxxxxxx> wrote:
> On Wed, 2018-07-11 at 17:10 +0200, Geert Uytterhoeven wrote:
> > Print a warning if none of the Signed-off-by lines cover the patch
> > author.
> >
> > Non-ASCII quoted printable encoding in From: headers and (lack of)
> > double quotes are handled.
> > Split From: headers are not fully handled: only the first part is
> > compared.
> []
> > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> []
> > +# Check the patch for a From:
> > +             if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
> > +                     $author = encode("utf8", $1);
> > +                     $author =~ s/"//g;
> > +             }
> > +
> >  # Check the patch for a signoff:
> >               if ($line =~ /^\s*signed-off-by:/i) {
> >                       $signoff++;
> >                       $in_commit_log = 0;
> > +                     if ($author ne '') {
> > +                             my $l = $line;
> > +                             $l =~ s/"//g;
> > +                             if ($l =~ /^\s*signed-off-by: \Q$author\E/i) {
> > +                                 $authorsignoff = 1;
> > +                             }
> > +                     }
> >               }
>
> I don't see the point of removing the quotes.

If the name contains a dot (e.g. "David S. Miller"), it must be protected
by double quotes in the From: email header, but that is usually not the case
in the Sob line.

> If the name and email address don't exactly match,
> why shouldn't it be reported?

It's still the same email address.

> >  # Check if MAINTAINERS is being updated.  If so, there's probably no need to
> > @@ -6487,9 +6503,14 @@ sub process {
> >               ERROR("NOT_UNIFIED_DIFF",
> >                     "Does not appear to be a unified-diff format patch\n");
> >       }
> > -     if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
> > -             ERROR("MISSING_SIGN_OFF",
> > -                   "Missing Signed-off-by: line(s)\n");
> > +     if ($is_patch && $has_commit_log && $chk_signoff) {
> > +             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 patch author\n");
>
> Perhaps better to show the From: line author
>
>                 "Missing 'Signed-off-by:' from nomimal patch author '$author'\n");

OK.

> Another somewhat frequent Signed-off-by: defect pattern
> is to have a lower-case name or no name at all used.
>
> Perhaps it'd be useful to add some checks like
> a single word for a name and all lower-case names:
>
> e.g.:
>         Signed-off-by: joe perches <joe@xxxxxxxxxxx>
>
> emits
>
> Unusual lower case name: 'joe perches <joe@xxxxxxxxxxx>'
>
> and
>         Signed-off-by: root <root@xxxxxxxxxxxx>
> and
>         Signed-off-by: Root <root@xxxxxxxxxxxx>
> and
>         Signed-off-by: root@xxxxxxxxxxxx
>
> all emit that a single or missing name is unusual.

Perhaps. But adding email addresses is not the topic of this patch.

Gr{oetje,eeting}s,

                        Geert

-- 
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@xxxxxxxxxxxxxx

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds