| Message ID | 20230823085632.116725-1-krzysztof.kozlowski@linaro.org (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 59da9885767a75df697c84c06aaf2296e10d85a4 |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | [net-next] net: dsa: use capital "OR" for multiple licenses in SPDX | expand |
On Wed Aug 23 2023, Krzysztof Kozlowski wrote: > Documentation/process/license-rules.rst and checkpatch expect the SPDX > identifier syntax for multiple licenses to use capital "OR". Correct it > to keep consistent format and avoid copy-paste issues. > > Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> Reviewed-by: Kurt Kanzenbach <kurt@linutronix.de> Side note: The SPDX spec in section D.2 says: "License expression operators (AND, OR and WITH) should be matched in a case-sensitive manner.". Should is not must. So I assume checkpatch and spdxcheck should handle both cases. Especially because: |linux (git)-[master] % git grep 'SPDX' | grep ' or ' | wc -l |370 Thanks, Kurt
On 23/08/2023 11:32, Kurt Kanzenbach wrote: > On Wed Aug 23 2023, Krzysztof Kozlowski wrote: >> Documentation/process/license-rules.rst and checkpatch expect the SPDX >> identifier syntax for multiple licenses to use capital "OR". Correct it >> to keep consistent format and avoid copy-paste issues. >> >> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> > > Reviewed-by: Kurt Kanzenbach <kurt@linutronix.de> > > Side note: The SPDX spec in section D.2 says: "License expression > operators (AND, OR and WITH) should be matched in a case-sensitive > manner.". Should is not must. So I assume checkpatch and spdxcheck > should handle both cases. Especially because: > > |linux (git)-[master] % git grep 'SPDX' | grep ' or ' | wc -l > |370 > But "should" denotes preferred rule: git grep "SPDX-Li" | grep " OR " | wc -l 7661 Best regards, Krzysztof
On Wed Aug 23 2023, Krzysztof Kozlowski wrote: > On 23/08/2023 11:32, Kurt Kanzenbach wrote: >> On Wed Aug 23 2023, Krzysztof Kozlowski wrote: >>> Documentation/process/license-rules.rst and checkpatch expect the SPDX >>> identifier syntax for multiple licenses to use capital "OR". Correct it >>> to keep consistent format and avoid copy-paste issues. >>> >>> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> >> >> Reviewed-by: Kurt Kanzenbach <kurt@linutronix.de> >> >> Side note: The SPDX spec in section D.2 says: "License expression >> operators (AND, OR and WITH) should be matched in a case-sensitive >> manner.". Should is not must. So I assume checkpatch and spdxcheck >> should handle both cases. Especially because: >> >> |linux (git)-[master] % git grep 'SPDX' | grep ' or ' | wc -l >> |370 >> > > But "should" denotes preferred rule: Yes, of course :). You mentioned checkpatch. But checkpatch doesn't warn about it. Or does it? |linux (git)-[master] % ./scripts/checkpatch.pl -- drivers/net/dsa/hirschmann/hellcreek.h |total: 0 errors, 0 warnings, 0 checks, 321 lines checked | |drivers/net/dsa/hirschmann/hellcreek.h has no obvious style problems and |is ready for submission. What about something like this? |linux (git)-[master*] % ./scripts/checkpatch.pl -- drivers/net/dsa/hirschmann/hellcreek.h |WARNING: License expression operators (AND, OR, WITH) should be upper case |#1: FILE: drivers/net/dsa/hirschmann/hellcreek.h:1: |+/* SPDX-License-Identifier: (GPL-2.0 or MIT) */ | |total: 0 errors, 1 warnings, 0 checks, 321 lines checked | |NOTE: For some of the reported defects, checkpatch may be able to | mechanically convert to the typical style using --fix or --fix-inplace. | |drivers/net/dsa/hirschmann/hellcreek.h has style problems, please review. | |NOTE: If any of the errors are false positives, please report | them to the maintainer, see CHECKPATCH in MAINTAINERS. Thanks, Kurt
On 23/08/2023 12:54, Kurt Kanzenbach wrote: > On Wed Aug 23 2023, Krzysztof Kozlowski wrote: >> On 23/08/2023 11:32, Kurt Kanzenbach wrote: >>> On Wed Aug 23 2023, Krzysztof Kozlowski wrote: >>>> Documentation/process/license-rules.rst and checkpatch expect the SPDX >>>> identifier syntax for multiple licenses to use capital "OR". Correct it >>>> to keep consistent format and avoid copy-paste issues. >>>> >>>> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> >>> >>> Reviewed-by: Kurt Kanzenbach <kurt@linutronix.de> >>> >>> Side note: The SPDX spec in section D.2 says: "License expression >>> operators (AND, OR and WITH) should be matched in a case-sensitive >>> manner.". Should is not must. So I assume checkpatch and spdxcheck >>> should handle both cases. Especially because: >>> >>> |linux (git)-[master] % git grep 'SPDX' | grep ' or ' | wc -l >>> |370 >>> >> >> But "should" denotes preferred rule: > > Yes, of course :). > > You mentioned checkpatch. But checkpatch doesn't warn about it. Or does > it? > > |linux (git)-[master] % ./scripts/checkpatch.pl -- drivers/net/dsa/hirschmann/hellcreek.h > |total: 0 errors, 0 warnings, 0 checks, 321 lines checked > | > |drivers/net/dsa/hirschmann/hellcreek.h has no obvious style problems and > |is ready for submission. Checkpatch checks licenses of only some files, so maybe I should change description here (it's you know, copy-paste...). Best regards, Krzysztof
On Wed Aug 23 2023, Krzysztof Kozlowski wrote: > On 23/08/2023 12:54, Kurt Kanzenbach wrote: >> On Wed Aug 23 2023, Krzysztof Kozlowski wrote: >>> On 23/08/2023 11:32, Kurt Kanzenbach wrote: >>>> On Wed Aug 23 2023, Krzysztof Kozlowski wrote: >>>>> Documentation/process/license-rules.rst and checkpatch expect the SPDX >>>>> identifier syntax for multiple licenses to use capital "OR". Correct it >>>>> to keep consistent format and avoid copy-paste issues. >>>>> >>>>> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> >>>> >>>> Reviewed-by: Kurt Kanzenbach <kurt@linutronix.de> >>>> >>>> Side note: The SPDX spec in section D.2 says: "License expression >>>> operators (AND, OR and WITH) should be matched in a case-sensitive >>>> manner.". Should is not must. So I assume checkpatch and spdxcheck >>>> should handle both cases. Especially because: >>>> >>>> |linux (git)-[master] % git grep 'SPDX' | grep ' or ' | wc -l >>>> |370 >>>> >>> >>> But "should" denotes preferred rule: >> >> Yes, of course :). >> >> You mentioned checkpatch. But checkpatch doesn't warn about it. Or does >> it? >> >> |linux (git)-[master] % ./scripts/checkpatch.pl -- drivers/net/dsa/hirschmann/hellcreek.h >> |total: 0 errors, 0 warnings, 0 checks, 321 lines checked >> | >> |drivers/net/dsa/hirschmann/hellcreek.h has no obvious style problems and >> |is ready for submission. > > Checkpatch checks licenses of only some files AFAICT it checks the license of all files. It calls spdxcheck on the SPDX identifier. It has some special rules for DT bindings etc. > so maybe I should change description here (it's you know, > copy-paste...). Sure. Thanks, Kurt
On 8/23/2023 1:56 AM, Krzysztof Kozlowski wrote: > Documentation/process/license-rules.rst and checkpatch expect the SPDX > identifier syntax for multiple licenses to use capital "OR". Correct it > to keep consistent format and avoid copy-paste issues. > > Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> > --- > drivers/net/dsa/b53/b53_serdes.c | 2 +- > drivers/net/dsa/b53/b53_serdes.h | 2 +- Reviewed-by: FLorian Fainelli <florian.fainelli@broadcom.com>
Hello: This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <kuba@kernel.org>: On Wed, 23 Aug 2023 10:56:32 +0200 you wrote: > Documentation/process/license-rules.rst and checkpatch expect the SPDX > identifier syntax for multiple licenses to use capital "OR". Correct it > to keep consistent format and avoid copy-paste issues. > > Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> > --- > drivers/net/dsa/b53/b53_serdes.c | 2 +- > drivers/net/dsa/b53/b53_serdes.h | 2 +- > drivers/net/dsa/hirschmann/hellcreek.c | 2 +- > drivers/net/dsa/hirschmann/hellcreek.h | 2 +- > include/linux/platform_data/hirschmann-hellcreek.h | 2 +- > 5 files changed, 5 insertions(+), 5 deletions(-) Here is the summary with links: - [net-next] net: dsa: use capital "OR" for multiple licenses in SPDX https://git.kernel.org/netdev/net-next/c/59da9885767a You are awesome, thank you!
diff --git a/drivers/net/dsa/b53/b53_serdes.c b/drivers/net/dsa/b53/b53_serdes.c index b0ccebcd3ffa..3f8a491ce885 100644 --- a/drivers/net/dsa/b53/b53_serdes.c +++ b/drivers/net/dsa/b53/b53_serdes.c @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: GPL-2.0 or BSD-3-Clause +// SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause /* * Northstar Plus switch SerDes/SGMII PHY main logic * diff --git a/drivers/net/dsa/b53/b53_serdes.h b/drivers/net/dsa/b53/b53_serdes.h index ef81f5da5f81..3d367c4df4d9 100644 --- a/drivers/net/dsa/b53/b53_serdes.h +++ b/drivers/net/dsa/b53/b53_serdes.h @@ -1,4 +1,4 @@ -/* SPDX-License-Identifier: GPL-2.0 or BSD-3-Clause */ +/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ /* * Northstar Plus switch SerDes/SGMII PHY definitions * diff --git a/drivers/net/dsa/hirschmann/hellcreek.c b/drivers/net/dsa/hirschmann/hellcreek.c index 720f4e4ed0b0..11ef1d7ea229 100644 --- a/drivers/net/dsa/hirschmann/hellcreek.c +++ b/drivers/net/dsa/hirschmann/hellcreek.c @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: (GPL-2.0 or MIT) +// SPDX-License-Identifier: (GPL-2.0 OR MIT) /* * DSA driver for: * Hirschmann Hellcreek TSN switch. diff --git a/drivers/net/dsa/hirschmann/hellcreek.h b/drivers/net/dsa/hirschmann/hellcreek.h index 4a678f7d61ae..6874cb9dc361 100644 --- a/drivers/net/dsa/hirschmann/hellcreek.h +++ b/drivers/net/dsa/hirschmann/hellcreek.h @@ -1,4 +1,4 @@ -/* SPDX-License-Identifier: (GPL-2.0 or MIT) */ +/* SPDX-License-Identifier: (GPL-2.0 OR MIT) */ /* * DSA driver for: * Hirschmann Hellcreek TSN switch. diff --git a/include/linux/platform_data/hirschmann-hellcreek.h b/include/linux/platform_data/hirschmann-hellcreek.h index 6a000df5541f..8748680e9e3c 100644 --- a/include/linux/platform_data/hirschmann-hellcreek.h +++ b/include/linux/platform_data/hirschmann-hellcreek.h @@ -1,4 +1,4 @@ -/* SPDX-License-Identifier: (GPL-2.0 or MIT) */ +/* SPDX-License-Identifier: (GPL-2.0 OR MIT) */ /* * Hirschmann Hellcreek TSN switch platform data. *
Documentation/process/license-rules.rst and checkpatch expect the SPDX identifier syntax for multiple licenses to use capital "OR". Correct it to keep consistent format and avoid copy-paste issues. Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> --- drivers/net/dsa/b53/b53_serdes.c | 2 +- drivers/net/dsa/b53/b53_serdes.h | 2 +- drivers/net/dsa/hirschmann/hellcreek.c | 2 +- drivers/net/dsa/hirschmann/hellcreek.h | 2 +- include/linux/platform_data/hirschmann-hellcreek.h | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-)