[v1] scripts: mandate use of SPDX-License-Identifier tags in new files

[PATCH 1/3] scripts: mandate that new files have SPDX-License-Identifier

Posted by Daniel P. Berrangé 1 year, 4 months ago

Going forward we want all newly created source files to have an
SPDX-License-Identifier tag present.

Initially mandate this for C, Python and Perl source files, and
encourage this for other file types.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
 scripts/checkpatch.pl | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 1b21249c91..cc266abdcd 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -1378,6 +1378,8 @@ sub process {
 	my $in_imported_file = 0;
 	my $in_no_imported_file = 0;
 	my $non_utf8_charset = 0;
+	my $expect_spdx = 0;
+	my $expect_spdx_file;
 
 	our @report = ();
 	our $cnt_lines = 0;
@@ -1615,6 +1617,30 @@ sub process {
 			WARN("added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
 		}
 
+# All new files should have a SPDX-License-Identifier tag
+		if ($line =~ /^new file mode\s*\d+\s*$/) {
+		    if ($expect_spdx) {
+			if ($expect_spdx_file =~ /\.(c|h|py|pl|c\.inc)$/) {
+			    # source code files MUST have SPDX license declared
+			    ERROR("expected 'SPDX-License-Identifer' in new file $expect_spdx_file");
+			} else {
+			    # Other files MAY have SPDX license if appropriate
+			    WARNING("Does new file $expect_spdx_file need 'SPDX-License-Identifer'?");
+			}
+		    }
+		    $expect_spdx = 1;
+		    $expect_spdx_file = undef;
+		} elsif ($expect_spdx) {
+		    $expect_spdx_file = $realfile unless defined $expect_spdx_file;
+
+		    # SPDX tagsd may occurr in comments which were
+		    # stripped from '$line', so use '$rawline'
+		    if ($rawline =~ /SPDX-License-Identifier/) {
+			$expect_spdx = 0;
+			$expect_spdx_file = undef;
+		    }
+		}
+
 # Check for wrappage within a valid hunk of the file
 		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
 			ERROR("patch seems to be corrupt (line wrapped?)\n" .
-- 
2.46.0

Re: [PATCH 1/3] scripts: mandate that new files have SPDX-License-Identifier

Posted by Philippe Mathieu-Daudé 1 year, 4 months ago

On 7/10/24 12:45, Daniel P. Berrangé wrote:
> Going forward we want all newly created source files to have an
> SPDX-License-Identifier tag present.
> 
> Initially mandate this for C, Python and Perl source files, and
> encourage this for other file types.
> 
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
>   scripts/checkpatch.pl | 26 ++++++++++++++++++++++++++
>   1 file changed, 26 insertions(+)
> 
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 1b21249c91..cc266abdcd 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -1378,6 +1378,8 @@ sub process {
>   	my $in_imported_file = 0;
>   	my $in_no_imported_file = 0;
>   	my $non_utf8_charset = 0;
> +	my $expect_spdx = 0;
> +	my $expect_spdx_file;
>   
>   	our @report = ();
>   	our $cnt_lines = 0;
> @@ -1615,6 +1617,30 @@ sub process {
>   			WARN("added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
>   		}
>   
> +# All new files should have a SPDX-License-Identifier tag
> +		if ($line =~ /^new file mode\s*\d+\s*$/) {
> +		    if ($expect_spdx) {
> +			if ($expect_spdx_file =~ /\.(c|h|py|pl|c\.inc)$/) {

[ch]\.inc to also mandat for *.h.inc?

Otherwise, thanks!
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>

> +			    # source code files MUST have SPDX license declared
> +			    ERROR("expected 'SPDX-License-Identifer' in new file $expect_spdx_file");
> +			} else {
> +			    # Other files MAY have SPDX license if appropriate
> +			    WARNING("Does new file $expect_spdx_file need 'SPDX-License-Identifer'?");
> +			}
> +		    }
> +		    $expect_spdx = 1;
> +		    $expect_spdx_file = undef;
> +		} elsif ($expect_spdx) {
> +		    $expect_spdx_file = $realfile unless defined $expect_spdx_file;
> +
> +		    # SPDX tagsd may occurr in comments which were
> +		    # stripped from '$line', so use '$rawline'
> +		    if ($rawline =~ /SPDX-License-Identifier/) {
> +			$expect_spdx = 0;
> +			$expect_spdx_file = undef;
> +		    }
> +		}
> +
>   # Check for wrappage within a valid hunk of the file
>   		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
>   			ERROR("patch seems to be corrupt (line wrapped?)\n" .

Re: [PATCH 1/3] scripts: mandate that new files have SPDX-License-Identifier

Posted by Brian Cain 1 year, 4 months ago

On 10/7/2024 10:45 AM, Daniel P. Berrangé wrote:
> Going forward we want all newly created source files to have an
> SPDX-License-Identifier tag present.
>
> Initially mandate this for C, Python and Perl source files, and
> encourage this for other file types.
>
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
>   scripts/checkpatch.pl | 26 ++++++++++++++++++++++++++
>   1 file changed, 26 insertions(+)
>
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 1b21249c91..cc266abdcd 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -1378,6 +1378,8 @@ sub process {
>   	my $in_imported_file = 0;
>   	my $in_no_imported_file = 0;
>   	my $non_utf8_charset = 0;
> +	my $expect_spdx = 0;
> +	my $expect_spdx_file;
>   
>   	our @report = ();
>   	our $cnt_lines = 0;
> @@ -1615,6 +1617,30 @@ sub process {
>   			WARN("added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
>   		}
>   
> +# All new files should have a SPDX-License-Identifier tag
> +		if ($line =~ /^new file mode\s*\d+\s*$/) {
> +		    if ($expect_spdx) {
> +			if ($expect_spdx_file =~ /\.(c|h|py|pl|c\.inc)$/) {
> +			    # source code files MUST have SPDX license declared
> +			    ERROR("expected 'SPDX-License-Identifer' in new file $expect_spdx_file");
> +			} else {
> +			    # Other files MAY have SPDX license if appropriate
> +			    WARNING("Does new file $expect_spdx_file need 'SPDX-License-Identifer'?");
> +			}
> +		    }
> +		    $expect_spdx = 1;
> +		    $expect_spdx_file = undef;
> +		} elsif ($expect_spdx) {
> +		    $expect_spdx_file = $realfile unless defined $expect_spdx_file;
> +
> +		    # SPDX tagsd may occurr in comments which were
> +		    # stripped from '$line', so use '$rawline'
> +		    if ($rawline =~ /SPDX-License-Identifier/) {
> +			$expect_spdx = 0;
> +			$expect_spdx_file = undef;
> +		    }
> +		}
> +
>   # Check for wrappage within a valid hunk of the file
>   		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
>   			ERROR("patch seems to be corrupt (line wrapped?)\n" .

This change makes sense to me, thanks for suggesting it.


Reviewed-by: Brian Cain <bcain@quicinc.com>