checkpatch.pl: Add SPDX license tag check for dts files and headers

Message ID 20170223155644.24213-1-robh@kernel.org
State New
Headers show

Commit Message

Rob Herring Feb. 23, 2017, 3:56 p.m.
Add a check for using SPDX-License-Identifier tags to define the license of
.dts{i} and DT header files rather than using free form license text. This
check looks for GPL, BSD, or X11(really incorrectly labeled MIT license)
license text which are the commonly used DT licenses.

Signed-off-by: Rob Herring <robh@kernel.org>

Cc: Andy Whitcroft <apw@canonical.com>
Cc: Joe Perches <joe@perches.com>
---
 scripts/checkpatch.pl | 13 +++++++++++++
 1 file changed, 13 insertions(+)

-- 
2.10.1

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Comments

Rob Herring Feb. 23, 2017, 6:45 p.m. | #1
On Thu, Feb 23, 2017 at 11:51 AM, Joe Perches <joe@perches.com> wrote:
> On Thu, 2017-02-23 at 09:56 -0600, Rob Herring wrote:

>> Add a check for using SPDX-License-Identifier tags to define the license of

>> .dts{i} and DT header files rather than using free form license text. This

>> check looks for GPL, BSD, or X11(really incorrectly labeled MIT license)

>> license text which are the commonly used DT licenses.

>

> Hi Rob.

>

>> Signed-off-by: Rob Herring <robh@kernel.org>

>> Cc: Andy Whitcroft <apw@canonical.com>

>> Cc: Joe Perches <joe@perches.com>

>> ---

>>  scripts/checkpatch.pl | 13 +++++++++++++

>>  1 file changed, 13 insertions(+)

>>

>> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl

>> index 982c52ca6473..ce802b3146e3 100755

>> --- a/scripts/checkpatch.pl

>> +++ b/scripts/checkpatch.pl

>> @@ -2139,6 +2139,7 @@ sub process {

>>       my $commit_log_has_diff = 0;

>>       my $reported_maintainer_file = 0;

>>       my $non_utf8_charset = 0;

>> +     my $licensefile = '';

>

> Maybe this should be $spdx_license_file

> but what's the actual reason to check if

> multiple license bits are in a single file?


Yes, just to get a single warning per file since the license matching
can get multiple hits.

Really what I'd like to do is warn if an SPDX tag is not present in
any added file. Having a check for something missing doesn't really
work well with checkpatch at least in a scalable way that I saw.

Rob
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Joe Perches Feb. 23, 2017, 7:10 p.m. | #2
On Thu, 2017-02-23 at 12:45 -0600, Rob Herring wrote:
> On Thu, Feb 23, 2017 at 11:51 AM, Joe Perches <joe@perches.com> wrote:

> > On Thu, 2017-02-23 at 09:56 -0600, Rob Herring wrote:

> > > Add a check for using SPDX-License-Identifier tags to define the license of

> > > .dts{i} and DT header files rather than using free form license text. This

> > > check looks for GPL, BSD, or X11(really incorrectly labeled MIT license)

> > > license text which are the commonly used DT licenses.

> > 

> > Hi Rob.

> > 

> > > Signed-off-by: Rob Herring <robh@kernel.org>

> > > Cc: Andy Whitcroft <apw@canonical.com>

> > > Cc: Joe Perches <joe@perches.com>

> > > ---

> > >  scripts/checkpatch.pl | 13 +++++++++++++

> > >  1 file changed, 13 insertions(+)

> > > 

> > > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl

> > > index 982c52ca6473..ce802b3146e3 100755

> > > --- a/scripts/checkpatch.pl

> > > +++ b/scripts/checkpatch.pl

> > > @@ -2139,6 +2139,7 @@ sub process {

> > >       my $commit_log_has_diff = 0;

> > >       my $reported_maintainer_file = 0;

> > >       my $non_utf8_charset = 0;

> > > +     my $licensefile = '';

> > 

> > Maybe this should be $spdx_license_file

> > but what's the actual reason to check if

> > multiple license bits are in a single file?

> 

> Yes, just to get a single warning per file since the license matching

> can get multiple hits.

> 

> Really what I'd like to do is warn if an SPDX tag is not present in

> any added file. Having a check for something missing doesn't really

> work well with checkpatch at least in a scalable way that I saw.


That isn't really possible with checkpatch as
I'm sure you know that it looks at patch
contexts and it isn't really meant to scan
entire files.

You might be better off with a separate script
like the checkincludes.pl one.

You might possibly integrate that script into
checkpatch by looking at the "new file mode"
block, remember those and see if in the patch
each appropriate file has one of the spdx tags.


--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Rob Herring June 9, 2017, 1:56 p.m. | #3
On Wed, Jun 07, 2017 at 05:45:03PM +0900, Masahiro Yamada wrote:
> Hi Rob,

> 

> 2017-02-24 0:56 GMT+09:00 Rob Herring <robh@kernel.org>:

> > Add a check for using SPDX-License-Identifier tags to define the license of

> > .dts{i} and DT header files rather than using free form license text. This

> > check looks for GPL, BSD, or X11(really incorrectly labeled MIT license)

> > license text which are the commonly used DT licenses.

> >

> > Signed-off-by: Rob Herring <robh@kernel.org>

> > Cc: Andy Whitcroft <apw@canonical.com>

> > Cc: Joe Perches <joe@perches.com>

> 

> I have a question.

> 

> Is SPDX encouraged only for DT?

> 

> What should we do with C source files?


Depends on the maintainer and your lawyer I guess. gregkh is 
supportive[1]. I wouldn't recommend changing existing license text 
though.

Rob

[1] https://lkml.org/lkml/2017/2/15/968
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch hide | download patch | download mbox

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 982c52ca6473..ce802b3146e3 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -2139,6 +2139,7 @@  sub process {
 	my $commit_log_has_diff = 0;
 	my $reported_maintainer_file = 0;
 	my $non_utf8_charset = 0;
+	my $licensefile = '';
 
 	my $last_blank_line = 0;
 	my $last_coalesced_string_linenr = -1;
@@ -2805,6 +2806,18 @@  sub process {
 			}
 		}
 
+# check for using SPDX tag instead of free form license text in dts and binding header files
+		if ($licensefile ne $realfile &&
+		    ($realfile =~ /\.dtsi?$/ || $realfile =~ /dt-bindings\/.*\.h$/) &&
+		    $rawline !~ /\bSPDX-License-Identifier/ &&
+		    ($rawline =~ /^\+.*\bGeneral\s+Public\s+License/i ||
+		    $rawline =~ /^\+.*\bTHE\s+SOFTWARE\s+IS\s+PROVIDED\s+\"AS\s+IS\"/i ||
+		    $rawline =~ /^\+.*\b(GPL|BSD|X11)/)) {
+			$licensefile = $realfile;
+			WARN("SPDX_LICENSE_TAG",
+			     "Use SPDX-License-Identifier tags instead of full license text\n" . $herecurr);
+		}
+
 # check we are in a valid source file if not then ignore this hunk
 		next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);