From nobody Sat Nov 23 17:52:47 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1732015800; cv=none; d=zohomail.com; s=zohoarc; b=HCq6hBE2qo4473BfDutGeUH3JEJM3JsAR1V4x0gBbc085UYgfSRExArOtGBCn+Sta+vau3B7ZDo2HX6gDZHJlKtl5ooWWxnaqXpgmmI8GKP9WUXyBzR4JFmoOH2Aw/xkUHln3N6IctlG30j53TgxZIo3ECDztGzig3jTicRQt2Y= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1732015800; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=eoysj6QLFedSKXBkmxOErJNFKamMY7nSKpDQjRdISxk=; b=kLGuRQ96Y2J8+gmsG7wLOPiwNMib7TgCWvHV8KGJN536lILshJuDUb+TW8RrY6PnR1QGBHTdpPKtW8iBkBGILlEWBmLpHW5YkYJai9Y7pKnn1BdDOU9gRh+SOmDTi6mLIuyMe/Q6WMJnZluy5R8EKxsWghx4IYXHBkmsJQGcsNw= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 173201580014729.364874990873886; Tue, 19 Nov 2024 03:30:00 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tDMQ0-0006HD-Ox; Tue, 19 Nov 2024 06:29:16 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tDMPz-0006GZ-86 for qemu-devel@nongnu.org; Tue, 19 Nov 2024 06:29:15 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tDMPx-0002gk-Lq for qemu-devel@nongnu.org; Tue, 19 Nov 2024 06:29:15 -0500 Received: from mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-19-Nt0KdOz5NTGYHRPXx4-vrw-1; Tue, 19 Nov 2024 06:29:09 -0500 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 76B4D1955EE9; Tue, 19 Nov 2024 11:29:08 +0000 (UTC) Received: from toolbox.redhat.com (unknown [10.42.28.110]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id CAE5E19560A3; Tue, 19 Nov 2024 11:29:06 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1732015752; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=eoysj6QLFedSKXBkmxOErJNFKamMY7nSKpDQjRdISxk=; b=ZrbCrFnfj+OStulSQMJ/2Lkm1RLn2MPB3YUmHakx9yy6I1QR14PvsKmrv+Ijx130BNhbxC 198FYZZtTymEq4h51ol7W99c8wtn/yL7R/w9tO3nPVMpGMIuV+HHg/8AVVCAgAPY3FaGTX a3wb9TccGcBHIuEtoEqxy3WNKD+kaUo= X-MC-Unique: Nt0KdOz5NTGYHRPXx4-vrw-1 X-Mimecast-MFC-AGG-ID: Nt0KdOz5NTGYHRPXx4-vrw From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: qemu-devel@nongnu.org Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Brian Cain , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= Subject: [PATCH v2 1/3] scripts: mandate that new files have SPDX-License-Identifier Date: Tue, 19 Nov 2024 11:29:01 +0000 Message-ID: <20241119112903.1010350-2-berrange@redhat.com> In-Reply-To: <20241119112903.1010350-1-berrange@redhat.com> References: <20241119112903.1010350-1-berrange@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=berrange@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.142, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1732015801733116600 Going forward we want all newly created source files to have an SPDX-License-Identifier tag present. Initially mandate this for C, Python, Perl, Shell source files, as well as JSON (QAPI) and Makefiles, while encouraging users to consider it for other file types. Reviewed-by: Brian Cain Reviewed-by: Philippe Mathieu-Daud=C3=A9 Signed-off-by: Daniel P. Berrang=C3=A9 --- scripts/checkpatch.pl | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index 06d07e6c22..d946121b8e 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -1378,6 +1378,8 @@ sub process { my $in_imported_file =3D 0; my $in_no_imported_file =3D 0; my $non_utf8_charset =3D 0; + my $expect_spdx =3D 0; + my $expect_spdx_file; =20 our @report =3D (); our $cnt_lines =3D 0; @@ -1615,6 +1617,30 @@ sub process { WARN("added, moved or deleted file(s), does MAINTAINERS need updating?\= n" . $herecurr); } =20 +# All new files should have a SPDX-License-Identifier tag + if ($line =3D~ /^new file mode\s*\d+\s*$/) { + if ($expect_spdx) { + if ($expect_spdx_file =3D~ /\.(c|h|py|pl|sh|json|inc|Makefile)$/) { + # source code files MUST have SPDX license declared + ERROR("New file '$expect_spdx_file' requires 'SPDX-License-Identife= r'"); + } else { + # Other files MAY have SPDX license if appropriate + WARNING("Does new file '$expect_spdx_file' need 'SPDX-License-Ident= ifer'?"); + } + } + $expect_spdx =3D 1; + $expect_spdx_file =3D undef; + } elsif ($expect_spdx) { + $expect_spdx_file =3D $realfile unless defined $expect_spdx_file; + + # SPDX tags may occurr in comments which were + # stripped from '$line', so use '$rawline' + if ($rawline =3D~ /SPDX-License-Identifier/) { + $expect_spdx =3D 0; + $expect_spdx_file =3D undef; + } + } + # Check for wrappage within a valid hunk of the file if ($realcnt !=3D 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { ERROR("patch seems to be corrupt (line wrapped?)\n" . --=20 2.46.0 From nobody Sat Nov 23 17:52:47 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1732015771; cv=none; d=zohomail.com; s=zohoarc; b=S3oSXW0iow6v6z44zel3UJYXUyG7lTgjKzeRqPtON6bWEk4tPLDGUtbhPAydFITDWBGblPWJCH2mlAKZlWpOpHgrLsnUZRrgK3mSy94MBoao0jfEkIgzBCtbOAlzvixd7QgDPcjaillBKvLH99qaYFGM4Wj/xAW4ebBHIA4bEz8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1732015771; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=bcIkVZ6uxzQG8FIq5djm31zQ2wixRzA9tY79S1pl6A8=; b=AJZPYY0IqR1IfgbZk3vIc2MVs56BAx1v0qEWvKIwUb2fLkePHlFNZOQpWuvweoJwGtTa8Q7uHi+YQVihEI2XVopSeR3VYPZ8eupaH40UMeKZf5L7VEmw8duoa44xt140vUI3g2jysFjH7ZdR+B2/ok4LKDRTnyAMKEZ2GuxOotw= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1732015771436129.19570865396588; Tue, 19 Nov 2024 03:29:31 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tDMPz-0006Gw-VA; Tue, 19 Nov 2024 06:29:15 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tDMPy-0006GO-QO for qemu-devel@nongnu.org; Tue, 19 Nov 2024 06:29:14 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tDMPx-0002gc-6I for qemu-devel@nongnu.org; Tue, 19 Nov 2024 06:29:14 -0500 Received: from mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-670-YcN6nFiiP66vOiIvpkPbHQ-1; Tue, 19 Nov 2024 06:29:10 -0500 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 18DE01956046 for ; Tue, 19 Nov 2024 11:29:10 +0000 (UTC) Received: from toolbox.redhat.com (unknown [10.42.28.110]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 0B8D219560A3; Tue, 19 Nov 2024 11:29:08 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1732015752; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=bcIkVZ6uxzQG8FIq5djm31zQ2wixRzA9tY79S1pl6A8=; b=Nv6QNzQYrctXHLol56Wy35DULVtXc+Iko1xmgsyKME9tMEbCGQQ2Bf8JtwRLn10ETO5XhA AU5TcWqK9hSwCpGVqlo9bFKJ7EYKbVqddkmiXXIC0yfD9O3Smp/yE3TthziDmOniXoXLKo S0OaV15r7RwjVWmjKVDPm8hF1pUtdqQ= X-MC-Unique: YcN6nFiiP66vOiIvpkPbHQ-1 X-Mimecast-MFC-AGG-ID: YcN6nFiiP66vOiIvpkPbHQ From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: qemu-devel@nongnu.org Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= Subject: [PATCH v2 2/3] scripts: validate SPDX license choices Date: Tue, 19 Nov 2024 11:29:02 +0000 Message-ID: <20241119112903.1010350-3-berrange@redhat.com> In-Reply-To: <20241119112903.1010350-1-berrange@redhat.com> References: <20241119112903.1010350-1-berrange@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.133.124; envelope-from=berrange@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.142, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1732015773697116600 We expect all new code to be contributed with the "GPL-2.0-or-later" license tag. Divergance is permitted if the new file is derived from pre-existing code under a different license, whether from elsewhere in QEMU codebase, or outside. Issue a warning if the declared license is not "GPL-2.0-or-later", and an error if the license is not one of the handful of the expected licenses to prevent unintended proliferation. The warning asks users to explain their unusual choice of license in the commit message. Signed-off-by: Daniel P. Berrang=C3=A9 --- scripts/checkpatch.pl | 68 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index d946121b8e..b507da8e2b 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -1353,6 +1353,69 @@ sub checkfilename { } } =20 +sub checkspdx { + my ($file, $expr) =3D @_; + + # Imported Linux headers probably have SPDX tags, but if they + # don't we're not requiring contributors to fix this, as these + # files are not expected to be modified locally in QEMU + if ($file =3D~ m,include/standard-headers, || + $file =3D~ m,linux-headers,) { + return; + } + + my $origexpr =3D $expr; + + # Flatten sub-expressions + $expr =3D~ s/\(|\)/ /g; + $expr =3D~ s/OR|AND/ /g; + + # Merge WITH exceptions to the license + $expr =3D~ s/\s+WITH\s+/-WITH-/g; + + # Cull more leading/trailing whitespace + $expr =3D~ s/^\s*//g; + $expr =3D~ s/\s*$//g; + + my @bits =3D split / +/, $expr; + + my $prefer =3D "GPL-2.0-or-later"; + my @valid =3D qw( + LGPL-2.0-or-later + LGPL-2.1-or-later + GPL-2.0-only + LGPL-2.0-only + LGPL-2.0-only + BSD-2-Clause + BSD-3-Clause + MIT + ); + + my $nonpreferred =3D 0; + my @unknown =3D (); + foreach my $bit (@bits) { + if ($bit eq $prefer) { + next; + } + if (grep /^$bit$/, @valid) { + $nonpreferred =3D 1; + } else { + push @unknown, $bit; + } + } + if (@unknown) { + ERROR("Saw unacceptable licenses '" . join(',', @unknown) . + "', valid choices for QEMU are:\n" . join("\n", $prefer, @valid)); + } + + if ($nonpreferred) { + WARN("Saw acceptable license '$origexpr' but note '$prefer' is preferred = " . + "for new files unless the code is derived from a source with an " . + "existed declared license that must be followed. Please explain " . + "license choice in the commit message"); + } +} + sub process { my $filename =3D shift; =20 @@ -1641,6 +1704,11 @@ sub process { } } =20 +# Check SPDX-License-Identifier references a permitted license + if ($rawline =3D~ m,SPDX-License-Identifier: (.*?)(\*/)?\s*$,) { + &checkspdx($realfile, $1); + } + # Check for wrappage within a valid hunk of the file if ($realcnt !=3D 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { ERROR("patch seems to be corrupt (line wrapped?)\n" . --=20 2.46.0 From nobody Sat Nov 23 17:52:47 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1732015798; cv=none; d=zohomail.com; s=zohoarc; b=mb2GsEsSAEZetzU/JY+FDsnw6oNLWdzVk9Rh8CRwfrIw6sd7mRhDMbY+bLTYv+XYVtuIklvQuc2gBftxYdjq5FksVVi9T26llqVnDC9zI5iFTWlcTNcBx0r8lvUNxvXj3B3xAap7RR3GK5RLK3g/vGXOmDIydHDqH5Jb/6oXmNw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1732015798; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=VjHw+rM/xFiWzRF6JRDZUYcBXpHlF84F+omw36DJmyA=; b=kv6BvKCAwRIztRdP5lBArqmY6Cs+dSB87kZZ7I7Me77GHpcWnrzLD4zd7XTXr+/MVwsUXiPGcSxmaa0GtDv+qxaCI8lhwCt136F+TNh5dUb0dMMi+L0uXP5w0RizssgkO+v2meRz57yLK5/V0O7Fr1m+nN8ywgljmOYDVLJQH8E= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1732015798413908.3082409075985; Tue, 19 Nov 2024 03:29:58 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tDMQ4-0006Hh-4R; Tue, 19 Nov 2024 06:29:20 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tDMQ1-0006HI-8R for qemu-devel@nongnu.org; Tue, 19 Nov 2024 06:29:17 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tDMPz-0002gu-PC for qemu-devel@nongnu.org; Tue, 19 Nov 2024 06:29:17 -0500 Received: from mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-684-au10FTZFMoaoSlqxxLz67w-1; Tue, 19 Nov 2024 06:29:12 -0500 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 067CE1955EE9; Tue, 19 Nov 2024 11:29:12 +0000 (UTC) Received: from toolbox.redhat.com (unknown [10.42.28.110]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id A75EA19560A3; Tue, 19 Nov 2024 11:29:10 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1732015754; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=VjHw+rM/xFiWzRF6JRDZUYcBXpHlF84F+omw36DJmyA=; b=TYjHqn9qUbbd/weURIyBnI3zDA2UIIWRZ5cfAaXjIuucWJzHDGCWDA74boW1IrV04ynLXT Cq5wvoffE964ljO4TFlgdSVeGYT7ZMUrFSV98vAJDL7xQotUm3UBaydHtHYvWn3isMxDFq L4/hbQOpOdZoFrQpghLAKDlqApDfcSQ= X-MC-Unique: au10FTZFMoaoSlqxxLz67w-1 X-Mimecast-MFC-AGG-ID: au10FTZFMoaoSlqxxLz67w From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: qemu-devel@nongnu.org Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= Subject: [PATCH v2 3/3] scripts: forbid use of arbitrary SPDX tags besides license identifiers Date: Tue, 19 Nov 2024 11:29:03 +0000 Message-ID: <20241119112903.1010350-4-berrange@redhat.com> In-Reply-To: <20241119112903.1010350-1-berrange@redhat.com> References: <20241119112903.1010350-1-berrange@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.133.124; envelope-from=berrange@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.142, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1732015799708116600 While SPDX-License-Identifier is a well known SPDX tag, there are a great many more besides that[1]. These are mostly focused on making machine readable metadata available to the 'reuse' tool and similar. They cover concepts like author names, copyright owners, and much more. It is even possible to define source file line groups and apply different SPDX tags to regions of code within a file. At this time we're only interested in adopting SPDX for recording the file global licensing info, so detect & reject any other SPDX metadata. If we want to explicitly collect extra data in SPDX format, we can evaluate each data item on its merits when someone wants to propose it at a later date. [1] https://spdx.github.io/spdx-spec/v2.2.2/file-tags/ https://spdx.github.io/spdx-spec/v2.2.2/file-information/ Reviewed-by: Philippe Mathieu-Daud=C3=A9 Signed-off-by: Daniel P. Berrang=C3=A9 --- scripts/checkpatch.pl | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index b507da8e2b..888b670d43 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -1709,6 +1709,18 @@ sub process { &checkspdx($realfile, $1); } =20 + if ($rawline =3D~ m,(SPDX-[a-zA-Z0-9-_]+):,) { + my $tag =3D $1; + my @permitted =3D qw( + SPDX-License-Identifier + ); + + unless (grep { /^$tag$/ } @permitted) { + ERROR("Tag $tag not permitted in QEMU code, valid " . + "choices are: " . join(", ", @permitted)); + } + } + # Check for wrappage within a valid hunk of the file if ($realcnt !=3D 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { ERROR("patch seems to be corrupt (line wrapped?)\n" . --=20 2.46.0