diff mbox series

[v2,1/3] Add SPDX to CODING_STYLE

Message ID 20220818220320.2538705-1-stefano.stabellini@amd.com (mailing list archive)
State Superseded
Headers show
Series introduce SPDX | expand

Commit Message

Stefano Stabellini Aug. 18, 2022, 10:03 p.m. UTC
Signed-off-by: Stefano Stabellini <stefano.stabellini@amd.com>
---
 CODING_STYLE | 10 ++++++++++
 1 file changed, 10 insertions(+)

Comments

Julien Grall Aug. 19, 2022, 7:33 a.m. UTC | #1
Hi Stefano,

On 18/08/2022 23:03, Stefano Stabellini wrote:
> Signed-off-by: Stefano Stabellini <stefano.stabellini@amd.com>
> ---
>   CODING_STYLE | 10 ++++++++++
>   1 file changed, 10 insertions(+)
> 
> diff --git a/CODING_STYLE b/CODING_STYLE
> index 3386ee1d90..5faf274b3a 100644
> --- a/CODING_STYLE
> +++ b/CODING_STYLE
> @@ -14,6 +14,16 @@ explicitly (e.g. tools/libxl/CODING_STYLE) but often implicitly (Linux
>   coding style is fairly common). In general you should copy the style
>   of the surrounding code. If you are unsure please ask.
>   
> +SPDX
> +----
> +
> +New files should start with a single-line SPDX comment to express the
> +license, e.g.:
> +
> +/* SPDX-License-Identifier: GPL-2.0 */
> +
> +See LICENSES/ for a list of licenses and SPDX tags currently used.
> +

A user reading CODING_STYLE and CONTRIBUTING may think they need to also 
add the full license (see the section "COMMON COPYRIGHT NOTICES").

So as we are going to promote SPDX, we should update CONTRIBUTING to 
reflect that the full license should not be present copied.

Cheers,
Jan Beulich Aug. 19, 2022, 7:54 a.m. UTC | #2
On 19.08.2022 00:03, Stefano Stabellini wrote:
> --- a/CODING_STYLE
> +++ b/CODING_STYLE
> @@ -14,6 +14,16 @@ explicitly (e.g. tools/libxl/CODING_STYLE) but often implicitly (Linux
>  coding style is fairly common). In general you should copy the style
>  of the surrounding code. If you are unsure please ask.
>  
> +SPDX
> +----
> +
> +New files should start with a single-line SPDX comment to express the
> +license, e.g.:
> +
> +/* SPDX-License-Identifier: GPL-2.0 */
> +
> +See LICENSES/ for a list of licenses and SPDX tags currently used.

In which case this patch should come after populating LICENSES/.

Jan
Stefano Stabellini Aug. 19, 2022, 10:24 p.m. UTC | #3
On Fri, 19 Aug 2022, Julien Grall wrote:
> Hi Stefano,
> 
> On 18/08/2022 23:03, Stefano Stabellini wrote:
> > Signed-off-by: Stefano Stabellini <stefano.stabellini@amd.com>
> > ---
> >   CODING_STYLE | 10 ++++++++++
> >   1 file changed, 10 insertions(+)
> > 
> > diff --git a/CODING_STYLE b/CODING_STYLE
> > index 3386ee1d90..5faf274b3a 100644
> > --- a/CODING_STYLE
> > +++ b/CODING_STYLE
> > @@ -14,6 +14,16 @@ explicitly (e.g. tools/libxl/CODING_STYLE) but often
> > implicitly (Linux
> >   coding style is fairly common). In general you should copy the style
> >   of the surrounding code. If you are unsure please ask.
> >   +SPDX
> > +----
> > +
> > +New files should start with a single-line SPDX comment to express the
> > +license, e.g.:
> > +
> > +/* SPDX-License-Identifier: GPL-2.0 */
> > +
> > +See LICENSES/ for a list of licenses and SPDX tags currently used.
> > +
> 
> A user reading CODING_STYLE and CONTRIBUTING may think they need to also add
> the full license (see the section "COMMON COPYRIGHT NOTICES").
> 
> So as we are going to promote SPDX, we should update CONTRIBUTING to reflect
> that the full license should not be present copied.

Yes good idea. Should I just remove the entire "COMMON COPYRIGHT
NOTICES" section? With SPDX there is really no value in having
sample copyright notices, I think I should take it all out.
Julien Grall Aug. 20, 2022, 6:33 p.m. UTC | #4
Hi Stefano,

On 19/08/2022 23:24, Stefano Stabellini wrote:
> On Fri, 19 Aug 2022, Julien Grall wrote:
>> Hi Stefano,
>>
>> On 18/08/2022 23:03, Stefano Stabellini wrote:
>>> Signed-off-by: Stefano Stabellini <stefano.stabellini@amd.com>
>>> ---
>>>    CODING_STYLE | 10 ++++++++++
>>>    1 file changed, 10 insertions(+)
>>>
>>> diff --git a/CODING_STYLE b/CODING_STYLE
>>> index 3386ee1d90..5faf274b3a 100644
>>> --- a/CODING_STYLE
>>> +++ b/CODING_STYLE
>>> @@ -14,6 +14,16 @@ explicitly (e.g. tools/libxl/CODING_STYLE) but often
>>> implicitly (Linux
>>>    coding style is fairly common). In general you should copy the style
>>>    of the surrounding code. If you are unsure please ask.
>>>    +SPDX
>>> +----
>>> +
>>> +New files should start with a single-line SPDX comment to express the
>>> +license, e.g.:
>>> +
>>> +/* SPDX-License-Identifier: GPL-2.0 */
>>> +
>>> +See LICENSES/ for a list of licenses and SPDX tags currently used.
>>> +
>>
>> A user reading CODING_STYLE and CONTRIBUTING may think they need to also add
>> the full license (see the section "COMMON COPYRIGHT NOTICES").
>>
>> So as we are going to promote SPDX, we should update CONTRIBUTING to reflect
>> that the full license should not be present copied.
> 
> Yes good idea. Should I just remove the entire "COMMON COPYRIGHT
> NOTICES" section?

I would say yes. You will need to tweak the first section of that file 
because it reference the section " COMMON COPYRIGHT NOTICES".

Cheers,
diff mbox series

Patch

diff --git a/CODING_STYLE b/CODING_STYLE
index 3386ee1d90..5faf274b3a 100644
--- a/CODING_STYLE
+++ b/CODING_STYLE
@@ -14,6 +14,16 @@  explicitly (e.g. tools/libxl/CODING_STYLE) but often implicitly (Linux
 coding style is fairly common). In general you should copy the style
 of the surrounding code. If you are unsure please ask.
 
+SPDX
+----
+
+New files should start with a single-line SPDX comment to express the
+license, e.g.:
+
+/* SPDX-License-Identifier: GPL-2.0 */
+
+See LICENSES/ for a list of licenses and SPDX tags currently used.
+
 MISRA C
 -------