linux-kernel - Re: checkpatch false positive (IMO): typo detected in truncated commit message

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <8f2948baf460575cde975a2cb5d11b960e8ae30f.camel@perches.com>
Date:   Mon, 25 Jun 2018 08:37:48 -0700
From:   Joe Perches <joe@...ches.com>
To:     Jann Horn <jannh@...gle.com>
Cc:     Andy Whitcroft <apw@...onical.com>,
        kernel list <linux-kernel@...r.kernel.org>
Subject: Re: checkpatch false positive (IMO): typo detected in truncated
 commit message

On Mon, 2018-06-25 at 17:32 +0200, Jann Horn wrote:
> On Mon, Jun 25, 2018 at 5:23 PM Joe Perches <joe@...ches.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.

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@...aro.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
[...]