clk: actions: Use the correct style for SPDX License Identifier
Subsystems (2)
PATCH 1/1 clk: actions: Use the correct style for SPDX License Identifier
This patch corrects the SPDX License Identifier style in header files related to Clock Drivers for Actions Semi Socs. For C header files Documentation/process/license-rules.rst mandates C-like comments (opposed to C source files where C++ style should be used)
Changes made by using a script provided by Joe Perches here:
https://lkml.org/lkml/2019/2/7/46
--- drivers/clk/actions/owl-common.h | 2 +- drivers/clk/actions/owl-composite.h | 2 +- drivers/clk/actions/owl-divider.h | 2 +- drivers/clk/actions/owl-factor.h | 2 +- drivers/clk/actions/owl-fixed-factor.h | 2 +- drivers/clk/actions/owl-gate.h | 2 +- drivers/clk/actions/owl-mux.h | 2 +- drivers/clk/actions/owl-pll.h | 2 +- drivers/clk/actions/owl-reset.h | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-)
drivers/clk/actions/owl-common.h +1 -1
@@ -1,4 +1,4 @@ -// SPDX-License-Identifier: GPL-2.0+ +/* SPDX-License-Identifier: GPL-2.0+ */ // // OWL common clock driver //
drivers/clk/actions/owl-composite.h +1 -1
@@ -1,4 +1,4 @@ -// SPDX-License-Identifier: GPL-2.0+ +/* SPDX-License-Identifier: GPL-2.0+ */ // // OWL composite clock driver //
drivers/clk/actions/owl-divider.h +1 -1
@@ -1,4 +1,4 @@ -// SPDX-License-Identifier: GPL-2.0+ +/* SPDX-License-Identifier: GPL-2.0+ */ // // OWL divider clock driver //
drivers/clk/actions/owl-factor.h +1 -1
@@ -1,4 +1,4 @@ -// SPDX-License-Identifier: GPL-2.0+ +/* SPDX-License-Identifier: GPL-2.0+ */ // // OWL factor clock driver //
drivers/clk/actions/owl-fixed-factor.h +1 -1
@@ -1,4 +1,4 @@ -// SPDX-License-Identifier: GPL-2.0+ +/* SPDX-License-Identifier: GPL-2.0+ */ // // OWL fixed factor clock driver //
drivers/clk/actions/owl-gate.h +1 -1
@@ -1,4 +1,4 @@ -// SPDX-License-Identifier: GPL-2.0+ +/* SPDX-License-Identifier: GPL-2.0+ */ // // OWL gate clock driver //
drivers/clk/actions/owl-mux.h +1 -1
@@ -1,4 +1,4 @@ -// SPDX-License-Identifier: GPL-2.0+ +/* SPDX-License-Identifier: GPL-2.0+ */ // // OWL mux clock driver //
drivers/clk/actions/owl-pll.h +1 -1
@@ -1,4 +1,4 @@ -// SPDX-License-Identifier: GPL-2.0+ +/* SPDX-License-Identifier: GPL-2.0+ */ // // OWL pll clock driver //
drivers/clk/actions/owl-reset.h +1 -1
@@ -1,4 +1,4 @@ -// SPDX-License-Identifier: GPL-2.0-or-later +/* SPDX-License-Identifier: GPL-2.0-or-later */ // // Actions Semi Owl SoCs Reset Management Unit driver //
Signature · 1 line
2.17.1
Quoting Nishad Kamdar (2019-05-01 00:07:11)
Quoted 6 lines
This patch corrects the SPDX License Identifier style in header files related to Clock Drivers for Actions Semi Socs. For C header files
Documentation/process/license-rules.rstmandates C-like comments (opposed to C source files where C++ style should be used)
Quoted 6 lines
Changes made by using a script provided by Joe Perches here:
https://lkml.org/lkml/2019/2/7/46Suggested-by Joe Perches <[email protected]>Signed-off-by Nishad Kamdar <[email protected]>---
Applied to clk-next
_______________________________________________
linux-arm-kernel mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Andreas Färber
maintainer+ linux-actions
Am 01.05.19 um 09:07 schrieb Nishad Kamdar:
Quoted 5 lines
This patch corrects the SPDX License Identifier style in header files related to Clock Drivers for Actions Semi Socs. For C header files
Documentation/process/license-rules.rstmandates C-like comments (opposed to C source files where C++ style should be used)
[...]
Quoted 10 lines
drivers/clk/actions/owl-common.h | 2 +- drivers/clk/actions/owl-composite.h | 2 +- drivers/clk/actions/owl-divider.h | 2 +- drivers/clk/actions/owl-factor.h | 2 +- drivers/clk/actions/owl-fixed-factor.h | 2 +- drivers/clk/actions/owl-gate.h | 2 +- drivers/clk/actions/owl-mux.h | 2 +- drivers/clk/actions/owl-pll.h | 2 +- drivers/clk/actions/owl-reset.h | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-)
Where's the practical benefit of this patch? These are all private headers used from C files, so they can handle C++ comments just fine, otherwise we would've seen build failures.
I could understand if you were patching files in include/ but not here.
Regards,
Andreas
Signature · 3 lines
SUSE Linux GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Felix Imendörffer, Mary Higgins, Sri Rasiah HRB 21284 (AG Nürnberg)
Quoted 20 lines · Andreas Färber
+ linux-actions
Am 01.05.19 um 09:07 schrieb Nishad Kamdar:
Quoted 5 lines
This patch corrects the SPDX License Identifier style in header files related to Clock Drivers for Actions Semi Socs. For C header files
Documentation/process/license-rules.rstmandates C-like comments (opposed to C source files where C++ style should be used)[...]
Quoted 10 lines
drivers/clk/actions/owl-common.h | 2 +- drivers/clk/actions/owl-composite.h | 2 +- drivers/clk/actions/owl-divider.h | 2 +- drivers/clk/actions/owl-factor.h | 2 +- drivers/clk/actions/owl-fixed-factor.h | 2 +- drivers/clk/actions/owl-gate.h | 2 +- drivers/clk/actions/owl-mux.h | 2 +- drivers/clk/actions/owl-pll.h | 2 +- drivers/clk/actions/owl-reset.h | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-)
Quoted 3 lines
Where's the practical benefit of this patch? These are all private headers used from C files, so they can handle C++ comments just fine, otherwise we would've seen build failures.
Please read Documentation/process/license-rules.rst, the section entitled "Style", for what the documented formats are for SPDX lines, depending on the file type.
thanks,
greg k-h
Andreas Färber
maintainerAm 02.05.19 um 09:07 schrieb Greg Kroah-Hartman:
Quoted 21 lines · Andreas Färber
Quoted 20 lines
+ linux-actions
Am 01.05.19 um 09:07 schrieb Nishad Kamdar:
Quoted 5 lines
This patch corrects the SPDX License Identifier style in header files related to Clock Drivers for Actions Semi Socs. For C header files
Documentation/process/license-rules.rstmandates C-like comments (opposed to C source files where C++ style should be used)[...]
Quoted 10 lines
drivers/clk/actions/owl-common.h | 2 +- drivers/clk/actions/owl-composite.h | 2 +- drivers/clk/actions/owl-divider.h | 2 +- drivers/clk/actions/owl-factor.h | 2 +- drivers/clk/actions/owl-fixed-factor.h | 2 +- drivers/clk/actions/owl-gate.h | 2 +- drivers/clk/actions/owl-mux.h | 2 +- drivers/clk/actions/owl-pll.h | 2 +- drivers/clk/actions/owl-reset.h | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-)
Quoted 7 lines
Quoted 3 lines
Where's the practical benefit of this patch? These are all private headers used from C files, so they can handle C++ comments just fine, otherwise we would've seen build failures.
Please read
Documentation/process/license-rules.rst, the section entitled "Style", for what the documented formats are for SPDX lines, depending on the file type.
That does in no way answer my question! You conveniently dropped my paragraph indicating that I understand why we would do that for public headers in include/, but none of these private headers here are included in .lds files. So there really seems to be no benefit of switching from one style to another for in-tree code.
Regards,
Andreas
Signature · 3 lines
SUSE Linux GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Felix Imendörffer, Mary Higgins, Sri Rasiah HRB 21284 (AG Nürnberg)
Quoted 30 lines · Andreas Färber
Am 02.05.19 um 09:07 schrieb Greg Kroah-Hartman:
Quoted 21 lines · Andreas Färber
Quoted 20 lines
+ linux-actions
Am 01.05.19 um 09:07 schrieb Nishad Kamdar:
Quoted 5 lines
This patch corrects the SPDX License Identifier style in header files related to Clock Drivers for Actions Semi Socs. For C header files
Documentation/process/license-rules.rstmandates C-like comments (opposed to C source files where C++ style should be used)[...]
Quoted 10 lines
drivers/clk/actions/owl-common.h | 2 +- drivers/clk/actions/owl-composite.h | 2 +- drivers/clk/actions/owl-divider.h | 2 +- drivers/clk/actions/owl-factor.h | 2 +- drivers/clk/actions/owl-fixed-factor.h | 2 +- drivers/clk/actions/owl-gate.h | 2 +- drivers/clk/actions/owl-mux.h | 2 +- drivers/clk/actions/owl-pll.h | 2 +- drivers/clk/actions/owl-reset.h | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-)Quoted 7 lines
Quoted 3 lines
Where's the practical benefit of this patch? These are all private headers used from C files, so they can handle C++ comments just fine, otherwise we would've seen build failures.
Please read
Documentation/process/license-rules.rst, the section entitled "Style", for what the documented formats are for SPDX lines, depending on the file type.
Quoted 5 lines
That does in no way answer my question! You conveniently dropped my paragraph indicating that I understand why we would do that for public headers in
include/, but none of these private headers here are included in .lds files. So there really seems to be no benefit of switching from one style to another for in-tree code.
It should answer the question, it was "decreed" that all header files use /* */, and all C files use // for their SPDX lines, so we documented it that way.
Yes, maybe it doesn't make "sense" in that this really is only needed for headers that get included into asm files, which is why we had to do it this way, but it's better to be consistant than to have random breakages at times.
It's not an issue of public headers at all, sorry.
Consistency is good, as we can have automatic tools check these types of things, which is the only way to reliably handle the format of something that needs to be in every file in a project with 63,100+ different files.
thanks,
greg k-h
Quoted 8 lines
Regards,
AndreasSignature · 3 lines
SUSE Linux GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Felix Imendörffer, Mary Higgins, Sri Rasiah HRB 21284 (AG Nürnberg)
Andreas Färber
maintainerAm 02.05.19 um 12:38 schrieb Greg Kroah-Hartman:
Quoted 46 lines · Andreas Färber
Quoted 30 lines
Am 02.05.19 um 09:07 schrieb Greg Kroah-Hartman:
Quoted 21 lines · Andreas Färber
Quoted 20 lines
+ linux-actions
Am 01.05.19 um 09:07 schrieb Nishad Kamdar:
Quoted 5 lines
This patch corrects the SPDX License Identifier style in header files related to Clock Drivers for Actions Semi Socs. For C header files
Documentation/process/license-rules.rstmandates C-like comments (opposed to C source files where C++ style should be used)[...]
Quoted 10 lines
drivers/clk/actions/owl-common.h | 2 +- drivers/clk/actions/owl-composite.h | 2 +- drivers/clk/actions/owl-divider.h | 2 +- drivers/clk/actions/owl-factor.h | 2 +- drivers/clk/actions/owl-fixed-factor.h | 2 +- drivers/clk/actions/owl-gate.h | 2 +- drivers/clk/actions/owl-mux.h | 2 +- drivers/clk/actions/owl-pll.h | 2 +- drivers/clk/actions/owl-reset.h | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-)Quoted 7 lines
Quoted 3 lines
Where's the practical benefit of this patch? These are all private headers used from C files, so they can handle C++ comments just fine, otherwise we would've seen build failures.
Please read
Documentation/process/license-rules.rst, the section entitled "Style", for what the documented formats are for SPDX lines, depending on the file type.Quoted 5 lines
That does in no way answer my question! You conveniently dropped my paragraph indicating that I understand why we would do that for public headers in
include/, but none of these private headers here are included in .lds files. So there really seems to be no benefit of switching from one style to another for in-tree code.It should answer the question, it was "decreed" that all header files use /* */, and all C files use // for their SPDX lines, so we documented it that way.
Yes, maybe it doesn't make "sense" in that this really is only needed for headers that get included into asm files, which is why we had to do it this way, but it's better to be consistant than to have random breakages at times.
Quoted 6 lines
It's not an issue of public headers at all, sorry.
Consistency is good, as we can have automatic tools check these types of things, which is the only way to reliably handle the format of something that needs to be in every file in a project with 63,100+ different files.
Okay, if it's about consistency then there will be more cases to fix.
What about this one:
My interpretation of the documentation has been that I should end the comment after the identifiers:
/* SPDX-... */
/* ...
*/
Some people deviate by doing
/* SPDX-...
* foo
*/
So the documentation may need to be extended to clarify that for full consistency, as well as clarify the previous scenario:
"If a specific tool cannot handle the standard comment style, then the
appropriate comment mechanism which the tool accepts shall be used."
To me that reads very different from what you just said above.
Thanks,
Andreas
Signature · 3 lines
SUSE Linux GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Felix Imendörffer, Mary Higgins, Sri Rasiah HRB 21284 (AG Nürnberg)
Quoted 47 lines · Andreas Färber
Am 02.05.19 um 12:38 schrieb Greg Kroah-Hartman:
Quoted 46 lines · Andreas Färber
Quoted 30 lines
Am 02.05.19 um 09:07 schrieb Greg Kroah-Hartman:
Quoted 21 lines · Andreas Färber
Quoted 20 lines
+ linux-actions
Am 01.05.19 um 09:07 schrieb Nishad Kamdar:
Quoted 5 lines
This patch corrects the SPDX License Identifier style in header files related to Clock Drivers for Actions Semi Socs. For C header files
Documentation/process/license-rules.rstmandates C-like comments (opposed to C source files where C++ style should be used)[...]
Quoted 10 lines
drivers/clk/actions/owl-common.h | 2 +- drivers/clk/actions/owl-composite.h | 2 +- drivers/clk/actions/owl-divider.h | 2 +- drivers/clk/actions/owl-factor.h | 2 +- drivers/clk/actions/owl-fixed-factor.h | 2 +- drivers/clk/actions/owl-gate.h | 2 +- drivers/clk/actions/owl-mux.h | 2 +- drivers/clk/actions/owl-pll.h | 2 +- drivers/clk/actions/owl-reset.h | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-)Quoted 7 lines
Quoted 3 lines
Where's the practical benefit of this patch? These are all private headers used from C files, so they can handle C++ comments just fine, otherwise we would've seen build failures.
Please read
Documentation/process/license-rules.rst, the section entitled "Style", for what the documented formats are for SPDX lines, depending on the file type.Quoted 5 lines
That does in no way answer my question! You conveniently dropped my paragraph indicating that I understand why we would do that for public headers in
include/, but none of these private headers here are included in .lds files. So there really seems to be no benefit of switching from one style to another for in-tree code.It should answer the question, it was "decreed" that all header files use /* */, and all C files use // for their SPDX lines, so we documented it that way.
Yes, maybe it doesn't make "sense" in that this really is only needed for headers that get included into asm files, which is why we had to do it this way, but it's better to be consistant than to have random breakages at times.
Quoted 8 lines
Quoted 6 lines
It's not an issue of public headers at all, sorry.
Consistency is good, as we can have automatic tools check these types of things, which is the only way to reliably handle the format of something that needs to be in every file in a project with 63,100+ different files.
Okay, if it's about consistency then there will be more cases to fix.
Agreed, hopefully checkpatch is up to date enough to catch these.
Quoted 8 lines
What about this one:
My interpretation of the documentation has been that I should end the comment after the identifiers:
/* SPDX-... */
/* ...
*/
Correct.
Quoted 5 lines
Some people deviate by doing
/* SPDX-...
* foo
*/
Not correct.
Quoted 5 lines
So the documentation may need to be extended to clarify that for full consistency, as well as clarify the previous scenario:
"If a specific tool cannot handle the standard comment style, then the
appropriate comment mechanism which the tool accepts shall be used."
To me that reads very different from what you just said above.
Documentation can always be updated, a patch to make it clearer is always appreciated. But look at what we have today in the document, I think it should be pretty obvious that:
/* SPDX... */
is the thing to use for C header files.
If you disagree, that's fine, please send a patch to make it clearer and we can all review it.
thanks,
greg k-h