linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Rob Herring <robh@kernel.org>
To: linux-kernel@vger.kernel.org
Cc: Andy Whitcroft <apw@canonical.com>, Joe Perches <joe@perches.com>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Subject: [PATCH v3] checkpatch.pl: Add SPDX license tag check
Date: Fri, 10 Nov 2017 14:19:09 -0600	[thread overview]
Message-ID: <20171110201909.6144-1-robh@kernel.org> (raw)

SPDX license tags are a thing now in the kernel[1]. It has also been
decided to make them the first line in files. As Linus put it:

"The real reason _I_ personally would like to see at least all the new
SPDX lines to go at the very top of the file is that every time when
we have some kind of ambiguity about placement, we end up with
multiple cases, and then people don't notice when merging, and you end
up having two - or you just end up having unnecessary merge conflicts
because two different people picked two different choices)."

Add a warning if SPDX-License-Identifier tag is not present in the first
line (or 2nd for #! scripts) of files.

[1] https://lwn.net/Articles/738235/

Cc: Andy Whitcroft <apw@canonical.com>
Cc: Joe Perches <joe@perches.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Rob Herring <robh@kernel.org>
---
v3:
- Since we specify that the tag goes on the 1st or 2nd line, the logic 
can be greatly simplified compared to v2 because we can just use the 
line number. And now the check is improved too.

I tested this on a variety of files and Greg's patches adding the tags. 
I did find one error in Greg's patches. The tags were placed on the 
2nd line even for scripts without a "#!" line. Want to know which ones? 
Well, you'll have to run checkpatch. :)

 scripts/checkpatch.pl | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 8b80bac055e4..50633d44b49b 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -2865,6 +2865,20 @@ sub process {
 			}
 		}
 
+# check for using SPDX license tag at beginning of files
+		if ($realfile !~ /Documentation/ && $rawline =~ /^\+/ &&
+		    !($realline == 1 && $rawline =~ /^[\s\+]#!/)) {
+			my $ln = 1;
+
+			if ($realline == 2 && $prevrawline =~ /^[\s\+]#!/) {
+				$ln++;
+			}
+			if ($realline == $ln xor $rawline =~ m@^\+(#|//|/\*) SPDX-License-Identifier: @) {
+				WARN("SPDX_LICENSE_TAG",
+				     "Missing or malformed SPDX-License-Identifier tag in 1st (or 2nd for scripts) line\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)$/);
 
-- 
2.14.1

             reply	other threads:[~2017-11-10 20:19 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-11-10 20:19 Rob Herring [this message]
2017-11-11 13:53 ` [PATCH v3] checkpatch.pl: Add SPDX license tag check Joe Perches
2017-11-11 14:22   ` Greg Kroah-Hartman
2017-11-11 14:26     ` Joe Perches

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=20171110201909.6144-1-robh@kernel.org \
    --to=robh@kernel.org \
    --cc=apw@canonical.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=joe@perches.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;
as well as URLs for NNTP newsgroup(s).