From: Joe Perches <joe@perches.com>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Nishad Kamdar <nishadkamdar@gmail.com>,
devel@driverdev.osuosl.org,
Forest Bond <forest@alittletooquiet.net>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH] staging: vt6656: Use the correct style for SPDX license Identifier
Date: Wed, 06 Feb 2019 23:17:35 -0800 [thread overview]
Message-ID: <65ceabf611b845b5d278dba73d30f16b33e10d6d.camel@perches.com> (raw)
In-Reply-To: <20190206162524.GA22989@kroah.com>
[-- Attachment #1: Type: text/plain, Size: 3401 bytes --]
On Wed, 2019-02-06 at 17:25 +0100, Greg Kroah-Hartman wrote:
> On Tue, Feb 05, 2019 at 10:59:40AM -0800, Joe Perches wrote:
> > On Tue, 2019-02-05 at 19:44 +0100, Greg Kroah-Hartman wrote:
> > > On Tue, Feb 05, 2019 at 08:36:24PM +0530, Nishad Kamdar wrote:
> > > > This patch corrects the style for SPDX license Identifier in mac.h
> > > > by using "/* */" in place of "//" as per Linux kernel licensing rules.
> > > > Issue found by checkpatch.
> > > >
> > > > Signed-off-by: Nishad Kamdar <nishadkamdar@gmail.com>
> > > > ---
> > > > drivers/staging/vt6656/mac.h | 4 ++--
> > > > 1 file changed, 2 insertions(+), 2 deletions(-)
> > > >
> > > > diff --git a/drivers/staging/vt6656/mac.h b/drivers/staging/vt6656/mac.h
> > > > index 94e700fcd0b6..75166020f7c6 100644
> > > > --- a/drivers/staging/vt6656/mac.h
> > > > +++ b/drivers/staging/vt6656/mac.h
> > > > @@ -1,5 +1,5 @@
> > > > -// SPDX-License-Identifier: GPL-2.0+
> > > > -/*
> > > > +/* SPDX-License-Identifier: GPL-2.0+
> > >
> > > Should really be:
> > >
> > > /* SPDX-License-Identifier: GPL-2.0+ */
> >
> > There's a fair number of style inconsistencies in the kernel
> > sources for that already.
> >
> > ~8% of the .h files that have an 'SPDX-License-Identifier:'
> > don't use the recommended style.
> >
> > $ git grep -h "SPDX-License" -- '*.h' | \
> > perl -p -e 's@Identifier:.*\*/*@Identifier: ... */@; s@Identifier: [^\.].*@Identifier:@' | \
> > sort | uniq -c | sort -rn
> > 8506 /* SPDX-License-Identifier: ... */
> > 593 // SPDX-License-Identifier:
> > 154 /* SPDX-License-Identifier:
> > 53 * SPDX-License-Identifier:
> > 1 * SPDX-License-Identifier: GPL-2.0
> > 1 //SPDX-License-Identifier:
> > 1 /* SPDX-License-Identifier: ... */
>
> Then let's fix them, the documentation says what the correct format is,
> there's no reason we can't actually follow what is written...
So here's a script that does most all of them except
the 50 or so that use the SPDX-License-Identifier
in the middle of a comment block.
Using:
$ git grep --name-only 'SPDX-License-Identifier:' -- '*.h' | \
xargs grep -L '/\* SPDX-License-Identifier:.*\*/'| \
while read file ; do perl -i update_spdx.perl $file ; done
produces
$ git diff --shortstat
748 files changed, 902 insertions(+), 902 deletions(-)
And
$ git grep -h "SPDX-License" -- '*.h' | \
perl -p -e 's@Identifier:.*\*/*@Identifier: ... */@; s@Identifier: [^\.].*@Identifier:@' | \
sort | uniq -c | sort -rn
9254 /* SPDX-License-Identifier: ... */
53 * SPDX-License-Identifier:
1 * SPDX-License-Identifier: GPL-2.0
1 /* SPDX-License-Identifier: ... */
and the perl script below is also attached
$ cat update_spdx.perl
local $/;
my $file = (<>);
my $spdx_regex = '/\*[ \t]*SPDX-License-Identifier:[ \t]*';
my $spdx_actual = '/* SPDX-License-Identifier: ';
# any // use converted to /* ... */
$file =~ s@^//[ \t]*SPDX-License-Identifier:[ \t]*(.*)\n@/* SPDX-License-Identifier: $1 */\n@;
# first line use with /* without trailing */ gets */ added and 2nd line updated
$file =~ m@^\s*${spdx_regex}([^\n]+)\n@;
if (defined $1 && $1 !~ m@\*/$@) {
$file =~ s@^[ \t]*${spdx_regex}([^\n]+)\n@${spdx_actual}$1 */\n/* @;
$file =~ s@^[ \t]*${spdx_regex}([^\n]+)\n[ \t]*/\*[ \t]+\*@${spdx_actual}$1\n/* @;
$file =~ s@^\s*${spdx_regex}([^\n]+)\n/\* \n@${spdx_actual}$1\n/*\n@;
}
print $file;
[-- Attachment #2: update_spdx.perl --]
[-- Type: application/x-perl, Size: 677 bytes --]
next prev parent reply other threads:[~2019-02-07 7:17 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-05 15:06 [PATCH] staging: vt6656: Use the correct style for SPDX license Identifier Nishad Kamdar
2019-02-05 18:44 ` Greg Kroah-Hartman
2019-02-05 18:59 ` Joe Perches
2019-02-06 16:25 ` Greg Kroah-Hartman
2019-02-07 7:17 ` Joe Perches [this message]
2019-02-13 14:22 ` Nishad Kamdar
2019-02-12 15:09 ` Nishad Kamdar
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=65ceabf611b845b5d278dba73d30f16b33e10d6d.camel@perches.com \
--to=joe@perches.com \
--cc=devel@driverdev.osuosl.org \
--cc=forest@alittletooquiet.net \
--cc=gregkh@linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=nishadkamdar@gmail.com \
/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;
as well as URLs for NNTP newsgroup(s).