From: Joe Perches <joe@perches.com>
To: Jann Horn <jannh@google.com>
Cc: Andy Whitcroft <apw@canonical.com>,
kernel list <linux-kernel@vger.kernel.org>
Subject: Re: checkpatch false positive (IMO): typo detected in truncated commit message
Date: Mon, 25 Jun 2018 09:16:28 -0700 [thread overview]
Message-ID: <263e7cee7dcc18db39f663cbc07b4985a1f8f891.camel@perches.com> (raw)
In-Reply-To: <CAG48ez2y_T5RfjF8sjM=vQBzoTBgeXenwMdc=-DB9XE-Vi73-w@mail.gmail.com>
On Mon, 2018-06-25 at 17:49 +0200, Jann Horn wrote:
> On Mon, Jun 25, 2018 at 5:37 PM Joe Perches <joe@perches.com> wrote:
> >
> > On Mon, 2018-06-25 at 17:32 +0200, Jann Horn wrote:
> > > On Mon, Jun 25, 2018 at 5:23 PM Joe Perches <joe@perches.com> wrote:
> > > >
> > > > On Mon, 2018-06-25 at 17:22 +0200, Jann Horn wrote:
> > > > > Hello!
> > > > >
> > > > > I got the following message from checkpatch:
> > > > >
> > > > > =======
> > > > > $ scripts/checkpatch.pl
> > > > > 0001-netfilter-nf_log-don-t-hold-nf_log_mutex-during-user.patch
> > > > > WARNING: 'calle' may be misspelled - perhaps 'called'?
> > > > > #15:
> > > > > Fixes: 266d07cb1c9a ("netfilter: nf_log: fix sleeping function calle[...]")
> > > > >
> > > > > total: 0 errors, 1 warnings, 0 checks, 20 lines checked
> > > > >
> > > > > NOTE: For some of the reported defects, checkpatch may be able to
> > > > > mechanically convert to the typical style using --fix or --fix-inplace.
> > > > >
> > > > > 0001-netfilter-nf_log-don-t-hold-nf_log_mutex-during-user.patch has
> > > > > style problems, please review.
> > > > >
> > > > > NOTE: If any of the errors are false positives, please report
> > > > > them to the maintainer, see CHECKPATCH in MAINTAINERS.
> > > > > =======
> > > > >
> > > > > I believe that it is appropriate here to truncate the commit message
> > > > > of the fixed commit.
> > > >
> > > > It's not.
> > >
> > > Looking at a bunch of other recent commits, I'm guessing that the
> > > accepted format is to use the complete commit message, without
> > > linebreaks, even if it goes over 75 columns?
> >
> > More common is to wrap the commit message on multiple lines.
>
> Really? Even in the "Fixes:" line?
>
> > For instance, the first commit match in -next:
> >
> > $ git log --format=email --grep=commit -1
> > From 1421f2b6b1aac2379844ba27ba09b0dc37ec2daa Mon Sep 17 00:00:00 2001
> > From: AKASHI Takahiro <takahiro.akashi@linaro.org>
> > Date: Fri, 15 Jun 2018 09:43:47 +1000
> > Subject: [PATCH] kernel/kexec_file.c: add walk_system_ram_res_rev()
> >
> > This function, being a variant of walk_system_ram_res() introduced in
> > commit 8c86e70acead ("resource: provide new functions to walk through
> > resources"), walks through a list of all the resources of System RAM in
> > [...]
>
> I just grepped through Linus' tree for precedent on the "Fixes:" line;
> these are the first couple I found:
>
> f5e350f021e04ea41d2e5d58487c33b05ba3d25b: overlong "Fixes:" line
> 6c6da92808442908287fae8ebb0ca041a52469f4: overlong "Fixes:" line
> 964d978433a4b9aa1368ff71227ca0027dd1e32f: overlong "Fixes:" line
> 71c8fc0c96abf8e53e74ed4d891d671e585f9076: overlong "Fixes:" line
> b5b7dd647f2d21b93f734ce890671cd908e69b0a: overlong "Fixes:" line
> So it looks like the consensus is to use the full commit message
> without truncation or linebreaks there?
Correct.
I didn't notice your patch was for a fixes: line.
Those are exempted from the long-line checkpatch test.
prev parent reply other threads:[~2018-06-25 16:16 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <CAG48ez02K0N6h-nfbnY81QAZoX1_gi4DTxuHxf1bSYiifu2v7g@mail.gmail.com>
2018-06-25 15:23 ` Joe Perches
2018-06-25 15:32 ` Jann Horn
2018-06-25 15:37 ` Joe Perches
2018-06-25 15:49 ` Jann Horn
2018-06-25 16:16 ` Joe Perches [this message]
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=263e7cee7dcc18db39f663cbc07b4985a1f8f891.camel@perches.com \
--to=joe@perches.com \
--cc=apw@canonical.com \
--cc=jannh@google.com \
--cc=linux-kernel@vger.kernel.org \
/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
all inboxes | Powered by JetHome®