[PATCH] CONTRIBUTING: Clarifications on how to handle license deviations

[PATCH] CONTRIBUTING: Clarifications on how to handle license deviations

[Lars Kurth]

This patch makes a few clarifications which were discussed on
IRC recently. 

Specifically: 
- Highlight the principle that license deviations
  should be brought to the attention of maintainers 
- Add a requirement for GPLv2 compatibility 
- Restructure the document toghlight  use-cases for  
  "New components" and "Importing code" clearer 
- Add conventions and instructions for "New files"

Signed-off-by: Lars Kurth <lars.kurth@citrix.com>
---
 CONTRIBUTING | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

diff --git a/CONTRIBUTING b/CONTRIBUTING
index cfee8f1567..63050e9141 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -19,6 +19,19 @@ Most notably:
  - tools/xl           : LGPL v2.1
  - xen/include/public : MIT license
 
+The COMMON COPYRIGHT NOTICES section of this document contains
+sample copyright notices for the most common licenses used within
+this repository.
+
+When creating new components, new files, or importing code please follow
+the conventions outlined below. As a general rule, whenever code using a
+license other than GPLv2 is introduced, attention must be drawn to the
+difference, such that maibtainers can make an informed decision about the
+deviation. Any new code must be GPLv2 compatible.
+
+New components
+--------------
+
 When creating new components and directories that contain a
 significant amount of files that are licensed under licenses other
 than GPLv2 or the license specified in the COPYING file, please
@@ -27,15 +40,21 @@ license text and a rationale for using a different license. This helps
 ensure that the license of this new component/directory is maintained
 consistently with the original intention.
 
+New files
+---------
+
+If specific files that differ from the license in a directory are introduced,
+exceptions should be highlighted and discussed in the commit message or cover
+letter introducing the file.
+
+Importing code
+--------------
+
 When importing code from other upstream projects into this repository,
 please create a README.source file in the directory the code is imported
 to, listing the original source of the code. An example can be found at
 m4/README.source
 
-The COMMON COPYRIGHT NOTICES section of this document contains
-sample copyright notices for the most common licenses used within
-this repository.
-
 Developer's Certificate of Origin
 ---------------------------------
 
-- 
2.13.0


_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

Re: [PATCH] CONTRIBUTING: Clarifications on how to handle license deviations

[Wei Liu]

On Mon, Nov 19, 2018 at 06:05:10PM +0000, Lars Kurth wrote:
> This patch makes a few clarifications which were discussed on
> IRC recently. 
> 
> Specifically: 
> - Highlight the principle that license deviations
>   should be brought to the attention of maintainers 
> - Add a requirement for GPLv2 compatibility 
> - Restructure the document toghlight  use-cases for  

to highlight

>   "New components" and "Importing code" clearer 
> - Add conventions and instructions for "New files"
> 
> Signed-off-by: Lars Kurth <lars.kurth@citrix.com>
> ---
>  CONTRIBUTING | 27 +++++++++++++++++++++++----
>  1 file changed, 23 insertions(+), 4 deletions(-)
> 
> diff --git a/CONTRIBUTING b/CONTRIBUTING
> index cfee8f1567..63050e9141 100644
> --- a/CONTRIBUTING
> +++ b/CONTRIBUTING
> @@ -19,6 +19,19 @@ Most notably:
>   - tools/xl           : LGPL v2.1
>   - xen/include/public : MIT license
>  
> +The COMMON COPYRIGHT NOTICES section of this document contains
> +sample copyright notices for the most common licenses used within
> +this repository.
> +
> +When creating new components, new files, or importing code please follow
> +the conventions outlined below. As a general rule, whenever code using a
> +license other than GPLv2 is introduced, attention must be drawn to the
> +difference, such that maibtainers can make an informed decision about the

maintainers

Overall this patch looks good to me.

Wei.

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

Re: [PATCH] CONTRIBUTING: Clarifications on how to handle license deviations

[Lars Kurth]

Thank you Wei,

On 06/12/2018, 14:09, "Wei Liu" <wei.liu2@citrix.com> wrote:

    On Mon, Nov 19, 2018 at 06:05:10PM +0000, Lars Kurth wrote:
    > This patch makes a few clarifications which were discussed on
    > IRC recently. 
    > 
    > Specifically: 
    > - Highlight the principle that license deviations
    >   should be brought to the attention of maintainers 
    > - Add a requirement for GPLv2 compatibility 
    > - Restructure the document toghlight  use-cases for  
    
    to highlight
    
    >   "New components" and "Importing code" clearer 
    > - Add conventions and instructions for "New files"
    > 
    > Signed-off-by: Lars Kurth <lars.kurth@citrix.com>
    > ---
    >  CONTRIBUTING | 27 +++++++++++++++++++++++----
    >  1 file changed, 23 insertions(+), 4 deletions(-)
    > 
    > diff --git a/CONTRIBUTING b/CONTRIBUTING
    > index cfee8f1567..63050e9141 100644
    > --- a/CONTRIBUTING
    > +++ b/CONTRIBUTING
    > @@ -19,6 +19,19 @@ Most notably:
    >   - tools/xl           : LGPL v2.1
    >   - xen/include/public : MIT license
    >  
    > +The COMMON COPYRIGHT NOTICES section of this document contains
    > +sample copyright notices for the most common licenses used within
    > +this repository.
    > +
    > +When creating new components, new files, or importing code please follow
    > +the conventions outlined below. As a general rule, whenever code using a
    > +license other than GPLv2 is introduced, attention must be drawn to the
    > +difference, such that maibtainers can make an informed decision about the
    
    maintainers
    
    Overall this patch looks good to me.
    
Anyone else any views, before I re-roll the patch
Lars    

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

Re: [PATCH v2] CONTRIBUTING: Clarifications on how to handle license deviations

[Wei Liu]

On Mon, Dec 10, 2018 at 11:33:09AM -0800, Lars Kurth wrote:
> This patch makes a few clarifications which were discussed on
> IRC recently. 
> 
> Specifically: 
> - Highlight the principle that license deviations
>   should be brought to the attention of maintainers 
> - Add a requirement for GPLv2 compatibility 
> - Restructure the document toghlight  use-cases for  

"tohlight" is still wrong.

This can be fixed while committing though.

>   "New components" and "Importing code" clearer 
> - Add conventions and instructions for "New files"
> 
> Changes since v1:
> - Fixed typo

Note to committers: this needs to be removed while committing.

The text looks good to me:

Acked-by: Wei Liu <wei.liu2@citrix.com>

No need to resend just for the commit message.

> 
> Signed-off-by: Lars Kurth <lars.kurth@citrix.com>
> ---
>  CONTRIBUTING | 27 +++++++++++++++++++++++----
>  1 file changed, 23 insertions(+), 4 deletions(-)
> 
> diff --git a/CONTRIBUTING b/CONTRIBUTING
> index cfee8f1567..63050e9141 100644
> --- a/CONTRIBUTING
> +++ b/CONTRIBUTING
> @@ -19,6 +19,19 @@ Most notably:
>   - tools/xl           : LGPL v2.1
>   - xen/include/public : MIT license
>  
> +The COMMON COPYRIGHT NOTICES section of this document contains
> +sample copyright notices for the most common licenses used within
> +this repository.
> +
> +When creating new components, new files, or importing code please follow
> +the conventions outlined below. As a general rule, whenever code using a
> +license other than GPLv2 is introduced, attention must be drawn to the
> +difference, such that maintainers can make an informed decision about the
> +deviation. Any new code must be GPLv2 compatible.
> +
> +New components
> +--------------
> +
>  When creating new components and directories that contain a
>  significant amount of files that are licensed under licenses other
>  than GPLv2 or the license specified in the COPYING file, please
> @@ -27,15 +40,21 @@ license text and a rationale for using a different license. This helps
>  ensure that the license of this new component/directory is maintained
>  consistently with the original intention.
>  
> +New files
> +---------
> +
> +If specific files that differ from the license in a directory are introduced,
> +exceptions should be highlighted and discussed in the commit message or cover
> +letter introducing the file.
> +
> +Importing code
> +--------------
> +
>  When importing code from other upstream projects into this repository,
>  please create a README.source file in the directory the code is imported
>  to, listing the original source of the code. An example can be found at
>  m4/README.source
>  
> -The COMMON COPYRIGHT NOTICES section of this document contains
> -sample copyright notices for the most common licenses used within
> -this repository.
> -
>  Developer's Certificate of Origin
>  ---------------------------------
>  
> -- 
> 2.13.0
> 

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

Re: [PATCH v2] CONTRIBUTING: Clarifications on how to handle license deviations

[Julien Grall]

Hi Lars,

On 10/12/2018 19:33, Lars Kurth wrote:
> This patch makes a few clarifications which were discussed on
> IRC recently.
> 
> Specifically:
> - Highlight the principle that license deviations
>    should be brought to the attention of maintainers
> - Add a requirement for GPLv2 compatibility
> - Restructure the document toghlight  use-cases for
>    "New components" and "Importing code" clearer
> - Add conventions and instructions for "New files"
> 
> Changes since v1:
> - Fixed typo
> 
> Signed-off-by: Lars Kurth <lars.kurth@citrix.com>

Acked-by: Julien Grall <julien.grall@arm.com>

Cheers,

> ---
>   CONTRIBUTING | 27 +++++++++++++++++++++++----
>   1 file changed, 23 insertions(+), 4 deletions(-)
> 
> diff --git a/CONTRIBUTING b/CONTRIBUTING
> index cfee8f1567..63050e9141 100644
> --- a/CONTRIBUTING
> +++ b/CONTRIBUTING
> @@ -19,6 +19,19 @@ Most notably:
>    - tools/xl           : LGPL v2.1
>    - xen/include/public : MIT license
>   
> +The COMMON COPYRIGHT NOTICES section of this document contains
> +sample copyright notices for the most common licenses used within
> +this repository.
> +
> +When creating new components, new files, or importing code please follow
> +the conventions outlined below. As a general rule, whenever code using a
> +license other than GPLv2 is introduced, attention must be drawn to the
> +difference, such that maintainers can make an informed decision about the
> +deviation. Any new code must be GPLv2 compatible.
> +
> +New components
> +--------------
> +
>   When creating new components and directories that contain a
>   significant amount of files that are licensed under licenses other
>   than GPLv2 or the license specified in the COPYING file, please
> @@ -27,15 +40,21 @@ license text and a rationale for using a different license. This helps
>   ensure that the license of this new component/directory is maintained
>   consistently with the original intention.
>   
> +New files
> +---------
> +
> +If specific files that differ from the license in a directory are introduced,
> +exceptions should be highlighted and discussed in the commit message or cover
> +letter introducing the file.
> +
> +Importing code
> +--------------
> +
>   When importing code from other upstream projects into this repository,
>   please create a README.source file in the directory the code is imported
>   to, listing the original source of the code. An example can be found at
>   m4/README.source
>   
> -The COMMON COPYRIGHT NOTICES section of this document contains
> -sample copyright notices for the most common licenses used within
> -this repository.
> -
>   Developer's Certificate of Origin
>   ---------------------------------
>   
> 

-- 
Julien Grall

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel