From: "Daniel P. Berrangé" <berrange@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Peter Maydell" <peter.maydell@linaro.org>,
"Cédric Le Goater" <clg@kaod.org>
Subject: Re: [PATCH v3 9/9] scripts/checkpatch: reject license boilerplate on new files
Date: Thu, 15 May 2025 17:05:08 +0100 [thread overview]
Message-ID: <aCYQtA4cU2xPyvPo@redhat.com> (raw)
In-Reply-To: <20250515135936.86760-10-berrange@redhat.com>
On Thu, May 15, 2025 at 02:59:36PM +0100, Daniel P. Berrangé wrote:
> The previous commit mandates use of SPDX-License-Identifier on common
> source files, and encourages it on all other files.
>
> Some contributors are none the less still also including the license
> boilerplate text. This is redundant and will potentially cause
> trouble if inconsistent with the SPDX declaration.
>
> Match common boilerplate text blurbs and report them as invalid,
> for newly added files.
>
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
> scripts/checkpatch.pl | 16 ++++++++++++++++
> 1 file changed, 16 insertions(+)
>
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 87050e6677..cb1942c021 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -1496,6 +1496,13 @@ sub process_end_of_file {
> "' need 'SPDX-License-Identifier'?");
> }
> }
> + if ($fileinfo->{action} eq "new" &&
> + !exists $fileinfo->{facts}->{sawboilerplate}) {
/face-palm - I forgot to remove the '!' here so the check is
inverted and my test patch had two very similarly named files
so didn't notice it :-(
> + ERROR("New file '" . $fileinfo->{filenew} . "' must " .
> + "not have license boilerplate header text unless " .
> + "this file is copied from existing code with such " .
> + "text already present.");
> + }
> }
>
> sub process {
> @@ -1798,6 +1805,15 @@ sub process {
> &checkspdx($realfile, $1);
> }
>
> + if ($rawline =~ /licensed under the terms of the GNU GPL/ ||
> + $rawline =~ /under the terms of the GNU General Public License/ ||
> + $rawline =~ /under the terms of the GNU Lesser General Public/ ||
> + $rawline =~ /Permission is hereby granted, free of charge/ ||
> + $rawline =~ /GNU GPL, version 2 or later/ ||
> + $rawline =~ /See the COPYING file/) {
> + $fileinfo->{facts}->{sawboilerplate} = 1;
> + }
> +
> if ($rawline =~ m,(SPDX-[a-zA-Z0-9-_]+):,) {
> my $tag = $1;
> my @permitted = qw(
> --
> 2.49.0
>
With regards,
Daniel
--
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o- https://fstop138.berrange.com :|
|: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
next prev parent reply other threads:[~2025-05-15 16:06 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-15 13:59 [PATCH v3 0/9] scripts/checkpatch: fix SPDX-License-Identifier detection Daniel P. Berrangé
2025-05-15 13:59 ` [PATCH v3 1/9] Revert "scripts: mandate that new files have SPDX-License-Identifier" Daniel P. Berrangé
2025-05-19 12:06 ` Peter Maydell
2025-05-15 13:59 ` [PATCH v3 2/9] scripts/checkpatch.pl: fix various indentation mistakes Daniel P. Berrangé
2025-05-19 12:12 ` Peter Maydell
2025-05-19 16:08 ` Daniel P. Berrangé
2025-05-19 16:27 ` Alex Bennée
2025-05-19 16:36 ` Daniel P. Berrangé
2025-05-19 16:39 ` Peter Maydell
2025-05-15 13:59 ` [PATCH v3 3/9] scripts/checkpatch: introduce tracking of file start/end Daniel P. Berrangé
2025-05-19 12:17 ` Peter Maydell
2025-05-15 13:59 ` [PATCH v3 4/9] scripts/checkpatch: use new hook for ACPI test data check Daniel P. Berrangé
2025-05-15 16:55 ` Cédric Le Goater
2025-05-19 12:29 ` Peter Maydell
2025-05-19 16:21 ` Daniel P. Berrangé
2025-05-15 13:59 ` [PATCH v3 5/9] scripts/checkpatch: use new hook for file permissions check Daniel P. Berrangé
2025-05-19 12:19 ` Peter Maydell
2025-05-15 13:59 ` [PATCH v3 6/9] scripts/checkpatch: expand pattern for matching makefiles Daniel P. Berrangé
2025-05-15 16:20 ` Cédric Le Goater
2025-05-19 12:22 ` Peter Maydell
2025-05-15 13:59 ` [PATCH v3 7/9] scripts/checkpatch: use new hook for MAINTAINERS update check Daniel P. Berrangé
2025-05-19 12:21 ` Peter Maydell
2025-05-15 13:59 ` [PATCH v3 8/9] scripts/checkpatch: reimplement mandate for SPDX-License-Identifier Daniel P. Berrangé
2025-05-19 12:21 ` Peter Maydell
2025-05-15 13:59 ` [PATCH v3 9/9] scripts/checkpatch: reject license boilerplate on new files Daniel P. Berrangé
2025-05-15 15:42 ` Cédric Le Goater
2025-05-15 16:05 ` Daniel P. Berrangé [this message]
2025-05-15 16:06 ` Cédric Le Goater
2025-05-15 16:19 ` Cédric Le Goater
2025-05-15 16:36 ` Daniel P. Berrangé
2025-05-19 12:41 ` Peter Maydell
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=aCYQtA4cU2xPyvPo@redhat.com \
--to=berrange@redhat.com \
--cc=clg@kaod.org \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.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).