[edk2-CCodingStandardsSpecification Patch V2] Change preferred license of EDK II to BSD+Patent

[edk2-CCodingStandardsSpecification Patch V2] Change preferred license of EDK II to BSD+Patent

[Michael D Kinney]

https://bugzilla.tianocore.org/show_bug.cgi?id=1656

Change the EDK II C Coding Standards Specification to state that
the preferred license of the EDK II is the BSD+Patent License and
that file headers should use SPDX license identifiers.

Remove the requirement that there are no blank lines between
the copyright statement and the SPDX identifier.  This rule is not
consistently followed.

Cc: Andrew Fish <afish@apple.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Leif Lindholm <leif.lindholm@linaro.org>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
---
 5_source_files/52_spacing.md             | 28 ++++++------------------
 5_source_files/53_include_files.md       | 10 +--------
 5_source_files/54_code_file_structure.md | 10 +--------
 README.md                                |  1 +
 appendix_a_common_examples.md            |  9 +-------
 5 files changed, 11 insertions(+), 47 deletions(-)

diff --git a/5_source_files/52_spacing.md b/5_source_files/52_spacing.md
index ddeabf7..fca0044 100644
--- a/5_source_files/52_spacing.md
+++ b/5_source_files/52_spacing.md
@@ -279,15 +279,7 @@ the preferred indentation, but two tabs (four spaces) is also acceptable.
   information for a person viewing the file for the first time.
 
   Copyright (C) --20XX, Acme Corporation. All rights reserved.<BR>
-  This program and the accompanying materials
-  are licensed and made available under the terms and conditions of
-  the BSD License which accompanies this distribution. The full
-  text of the license may be found at
-  http://opensource.org/licenses/bsd-license.
-
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS"
-  BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER
-  EXPRESS OR IMPLIED.
+  SPDX-License-Identifier: BSD-2-Clause-Patent
 
   @par Revision Reference:
     - PI Version 1.0
@@ -364,22 +356,16 @@ the location and content of the file. The correct license will be determined by
 the project leader at the time the file is created. In most cases, the license
 will be the same as for other files in the module or package.
 
-The majority of the files in EDK II contain the following "BSD" license.
+The preferred license for EDK II is the "BSD+Patent" license.  The license for
+a file is provided in the file header using an SPDX identifier.  The following
+shows the SPDX identifier for the "BSD+Patent" license.
 
 ```
-This program and the accompanying materials are licensed and made
-available under the terms and conditions of the BSD License that
-accompanies this distribution. The full text of the license may be
-found at http://opensource.org/licenses/bsd-license.
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR
-IMPLIED.
+SPDX-License-Identifier: BSD-2-Clause-Patent
 ```
 
-The license will follow the copyright notice without an intervening blank line.
-It will be separated from the Specification Reference, if present, by a single
-blank line.
+The license follows the copyright notice.  The license is separated from the
+Specification Reference, if present, by a single blank line.
 
 #### 5.2.3.5 Specification Reference
 
diff --git a/5_source_files/53_include_files.md b/5_source_files/53_include_files.md
index 890e1c7..a859b76 100644
--- a/5_source_files/53_include_files.md
+++ b/5_source_files/53_include_files.md
@@ -151,15 +151,7 @@ Not all types of declarations are present in every file.
   you should probably also explain your rationale.
 
   Copyright (c) 20XX, Acme Corporation. All rights reserved.<BR>
-  This program and the accompanying materials
-  are licensed and made available under the terms and conditions of
-  the BSD License which accompanies this distribution. The full
-  text of the license may be found at
-  http://opensource.org/licenses/bsd-license.
-
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS"
-  BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER
-  EXPRESS OR IMPLIED.
+  SPDX-License-Identifier: BSD-2-Clause-Patent
 
   @par Specification Reference:
     - UEFI 2.3, Chapter 9, Device Path Protocol
diff --git a/5_source_files/54_code_file_structure.md b/5_source_files/54_code_file_structure.md
index 8cc9f4f..caaeab9 100644
--- a/5_source_files/54_code_file_structure.md
+++ b/5_source_files/54_code_file_structure.md
@@ -45,15 +45,7 @@ these are C files with an extension of "`.c`".
   you should probably also explain your rationale.
 
   Copyright (c) 20XX, Acme Corporation. All rights reserved.<BR>
-  This program and the accompanying materials
-  are licensed and made available under the terms and conditions of
-  the BSD License which accompanies this distribution. The full
-  text of the license may be found at
-  http://opensource.org/licenses/bsd-license.php
-
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS"
-  BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER
-  EXPRESS OR IMPLIED.
+  SPDX-License-Identifier: BSD-2-Clause-Patent
 
   @par Specification Reference:
     - UEFI 2.3, Chapter 9, Device Path Protocol
diff --git a/README.md b/README.md
index 8b9675b..e261335 100644
--- a/README.md
+++ b/README.md
@@ -112,3 +112,4 @@ Copyright (c) 2006-2017, Intel Corporation. All rights reserved.
 | 2.1      | DRAFT for REFORMAT                                                                                                                                | 10/30/2015 |
 | 2.2      | Convert to Gitbook                                                                                                                                | June 2017  |
 |          | [#425](https://bugzilla.tianocore.org/show_bug.cgi?id=425) [CCS] clarify line breaking and indentation requirements for multi-line function calls |            |
+|          | [#1656](https://bugzilla.tianocore.org/show_bug.cgi?id=1656) Update all Wiki pages for the BSD+Patent license change with SPDX identifiers        |            |
diff --git a/appendix_a_common_examples.md b/appendix_a_common_examples.md
index 1f247f3..d7b1a89 100644
--- a/appendix_a_common_examples.md
+++ b/appendix_a_common_examples.md
@@ -40,14 +40,7 @@
   Detailed description of file’s purpose.
 
   Copyright (c) 2006 - 2014, Acme Corporation. All rights reserved.<BR>
-  This program and the accompanying materials
-  are licensed and made available under the terms and conditions
-  of the BSD License which accompanies this distribution. The full
-  text of the license may be found at
-  http://opensource.org/licenses/bsd-license.php
-
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+  SPDX-License-Identifier: BSD-2-Clause-Patent
 
   @par Specification Reference:
   - UEFI 2.3, Chapter 9, Device Path Protocol
-- 
2.21.0.windows.1

Re: [edk2-CCodingStandardsSpecification Patch V2] Change preferred license of EDK II to BSD+Patent

[Laszlo Ersek]

On 04/17/19 19:27, Michael D Kinney wrote:
> https://bugzilla.tianocore.org/show_bug.cgi?id=1656
> 
> Change the EDK II C Coding Standards Specification to state that
> the preferred license of the EDK II is the BSD+Patent License and
> that file headers should use SPDX license identifiers.
> 
> Remove the requirement that there are no blank lines between
> the copyright statement and the SPDX identifier.  This rule is not
> consistently followed.
> 
> Cc: Andrew Fish <afish@apple.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Cc: Leif Lindholm <leif.lindholm@linaro.org>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
> ---
>  5_source_files/52_spacing.md             | 28 ++++++------------------
>  5_source_files/53_include_files.md       | 10 +--------
>  5_source_files/54_code_file_structure.md | 10 +--------
>  README.md                                |  1 +
>  appendix_a_common_examples.md            |  9 +-------
>  5 files changed, 11 insertions(+), 47 deletions(-)
> 
> diff --git a/5_source_files/52_spacing.md b/5_source_files/52_spacing.md
> index ddeabf7..fca0044 100644
> --- a/5_source_files/52_spacing.md
> +++ b/5_source_files/52_spacing.md
> @@ -279,15 +279,7 @@ the preferred indentation, but two tabs (four spaces) is also acceptable.
>    information for a person viewing the file for the first time.
>  
>    Copyright (C) --20XX, Acme Corporation. All rights reserved.<BR>
> -  This program and the accompanying materials
> -  are licensed and made available under the terms and conditions of
> -  the BSD License which accompanies this distribution. The full
> -  text of the license may be found at
> -  http://opensource.org/licenses/bsd-license.
> -
> -  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS"
> -  BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER
> -  EXPRESS OR IMPLIED.
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
>  
>    @par Revision Reference:
>      - PI Version 1.0
> @@ -364,22 +356,16 @@ the location and content of the file. The correct license will be determined by
>  the project leader at the time the file is created. In most cases, the license
>  will be the same as for other files in the module or package.
>  
> -The majority of the files in EDK II contain the following "BSD" license.
> +The preferred license for EDK II is the "BSD+Patent" license.  The license for
> +a file is provided in the file header using an SPDX identifier.  The following
> +shows the SPDX identifier for the "BSD+Patent" license.
>  
>  ```
> -This program and the accompanying materials are licensed and made
> -available under the terms and conditions of the BSD License that
> -accompanies this distribution. The full text of the license may be
> -found at http://opensource.org/licenses/bsd-license.
> -
> -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR
> -IMPLIED.
> +SPDX-License-Identifier: BSD-2-Clause-Patent
>  ```
>  
> -The license will follow the copyright notice without an intervening blank line.
> -It will be separated from the Specification Reference, if present, by a single
> -blank line.
> +The license follows the copyright notice.  The license is separated from the
> +Specification Reference, if present, by a single blank line.
>  
>  #### 5.2.3.5 Specification Reference
>  
> diff --git a/5_source_files/53_include_files.md b/5_source_files/53_include_files.md
> index 890e1c7..a859b76 100644
> --- a/5_source_files/53_include_files.md
> +++ b/5_source_files/53_include_files.md
> @@ -151,15 +151,7 @@ Not all types of declarations are present in every file.
>    you should probably also explain your rationale.
>  
>    Copyright (c) 20XX, Acme Corporation. All rights reserved.<BR>
> -  This program and the accompanying materials
> -  are licensed and made available under the terms and conditions of
> -  the BSD License which accompanies this distribution. The full
> -  text of the license may be found at
> -  http://opensource.org/licenses/bsd-license.
> -
> -  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS"
> -  BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER
> -  EXPRESS OR IMPLIED.
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
>  
>    @par Specification Reference:
>      - UEFI 2.3, Chapter 9, Device Path Protocol
> diff --git a/5_source_files/54_code_file_structure.md b/5_source_files/54_code_file_structure.md
> index 8cc9f4f..caaeab9 100644
> --- a/5_source_files/54_code_file_structure.md
> +++ b/5_source_files/54_code_file_structure.md
> @@ -45,15 +45,7 @@ these are C files with an extension of "`.c`".
>    you should probably also explain your rationale.
>  
>    Copyright (c) 20XX, Acme Corporation. All rights reserved.<BR>
> -  This program and the accompanying materials
> -  are licensed and made available under the terms and conditions of
> -  the BSD License which accompanies this distribution. The full
> -  text of the license may be found at
> -  http://opensource.org/licenses/bsd-license.php
> -
> -  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS"
> -  BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER
> -  EXPRESS OR IMPLIED.
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
>  
>    @par Specification Reference:
>      - UEFI 2.3, Chapter 9, Device Path Protocol
> diff --git a/README.md b/README.md
> index 8b9675b..e261335 100644
> --- a/README.md
> +++ b/README.md
> @@ -112,3 +112,4 @@ Copyright (c) 2006-2017, Intel Corporation. All rights reserved.
>  | 2.1      | DRAFT for REFORMAT                                                                                                                                | 10/30/2015 |
>  | 2.2      | Convert to Gitbook                                                                                                                                | June 2017  |
>  |          | [#425](https://bugzilla.tianocore.org/show_bug.cgi?id=425) [CCS] clarify line breaking and indentation requirements for multi-line function calls |            |
> +|          | [#1656](https://bugzilla.tianocore.org/show_bug.cgi?id=1656) Update all Wiki pages for the BSD+Patent license change with SPDX identifiers        |            |
> diff --git a/appendix_a_common_examples.md b/appendix_a_common_examples.md
> index 1f247f3..d7b1a89 100644
> --- a/appendix_a_common_examples.md
> +++ b/appendix_a_common_examples.md
> @@ -40,14 +40,7 @@
>    Detailed description of file’s purpose.
>  
>    Copyright (c) 2006 - 2014, Acme Corporation. All rights reserved.<BR>
> -  This program and the accompanying materials
> -  are licensed and made available under the terms and conditions
> -  of the BSD License which accompanies this distribution. The full
> -  text of the license may be found at
> -  http://opensource.org/licenses/bsd-license.php
> -
> -  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> -  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
>  
>    @par Specification Reference:
>    - UEFI 2.3, Chapter 9, Device Path Protocol
> 

Reviewed-by: Laszlo Ersek <lersek@redhat.com>

Re: [edk2-devel] [edk2-CCodingStandardsSpecification Patch V2] Change preferred license of EDK II to BSD+Patent

[Philippe Mathieu-Daudé]

On 4/17/19 7:27 PM, Michael D Kinney wrote:
> https://bugzilla.tianocore.org/show_bug.cgi?id=1656
> 
> Change the EDK II C Coding Standards Specification to state that
> the preferred license of the EDK II is the BSD+Patent License and
> that file headers should use SPDX license identifiers.
> 
> Remove the requirement that there are no blank lines between
> the copyright statement and the SPDX identifier.  This rule is not
> consistently followed.
> 
> Cc: Andrew Fish <afish@apple.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Cc: Leif Lindholm <leif.lindholm@linaro.org>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>

Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>

> ---
>  5_source_files/52_spacing.md             | 28 ++++++------------------
>  5_source_files/53_include_files.md       | 10 +--------
>  5_source_files/54_code_file_structure.md | 10 +--------
>  README.md                                |  1 +
>  appendix_a_common_examples.md            |  9 +-------
>  5 files changed, 11 insertions(+), 47 deletions(-)
> 
> diff --git a/5_source_files/52_spacing.md b/5_source_files/52_spacing.md
> index ddeabf7..fca0044 100644
> --- a/5_source_files/52_spacing.md
> +++ b/5_source_files/52_spacing.md
> @@ -279,15 +279,7 @@ the preferred indentation, but two tabs (four spaces) is also acceptable.
>    information for a person viewing the file for the first time.
>  
>    Copyright (C) --20XX, Acme Corporation. All rights reserved.<BR>
> -  This program and the accompanying materials
> -  are licensed and made available under the terms and conditions of
> -  the BSD License which accompanies this distribution. The full
> -  text of the license may be found at
> -  http://opensource.org/licenses/bsd-license.
> -
> -  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS"
> -  BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER
> -  EXPRESS OR IMPLIED.
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
>  
>    @par Revision Reference:
>      - PI Version 1.0
> @@ -364,22 +356,16 @@ the location and content of the file. The correct license will be determined by
>  the project leader at the time the file is created. In most cases, the license
>  will be the same as for other files in the module or package.
>  
> -The majority of the files in EDK II contain the following "BSD" license.
> +The preferred license for EDK II is the "BSD+Patent" license.  The license for
> +a file is provided in the file header using an SPDX identifier.  The following
> +shows the SPDX identifier for the "BSD+Patent" license.
>  
>  ```
> -This program and the accompanying materials are licensed and made
> -available under the terms and conditions of the BSD License that
> -accompanies this distribution. The full text of the license may be
> -found at http://opensource.org/licenses/bsd-license.
> -
> -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR
> -IMPLIED.
> +SPDX-License-Identifier: BSD-2-Clause-Patent
>  ```
>  
> -The license will follow the copyright notice without an intervening blank line.
> -It will be separated from the Specification Reference, if present, by a single
> -blank line.
> +The license follows the copyright notice.  The license is separated from the
> +Specification Reference, if present, by a single blank line.
>  
>  #### 5.2.3.5 Specification Reference
>  
> diff --git a/5_source_files/53_include_files.md b/5_source_files/53_include_files.md
> index 890e1c7..a859b76 100644
> --- a/5_source_files/53_include_files.md
> +++ b/5_source_files/53_include_files.md
> @@ -151,15 +151,7 @@ Not all types of declarations are present in every file.
>    you should probably also explain your rationale.
>  
>    Copyright (c) 20XX, Acme Corporation. All rights reserved.<BR>
> -  This program and the accompanying materials
> -  are licensed and made available under the terms and conditions of
> -  the BSD License which accompanies this distribution. The full
> -  text of the license may be found at
> -  http://opensource.org/licenses/bsd-license.
> -
> -  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS"
> -  BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER
> -  EXPRESS OR IMPLIED.
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
>  
>    @par Specification Reference:
>      - UEFI 2.3, Chapter 9, Device Path Protocol
> diff --git a/5_source_files/54_code_file_structure.md b/5_source_files/54_code_file_structure.md
> index 8cc9f4f..caaeab9 100644
> --- a/5_source_files/54_code_file_structure.md
> +++ b/5_source_files/54_code_file_structure.md
> @@ -45,15 +45,7 @@ these are C files with an extension of "`.c`".
>    you should probably also explain your rationale.
>  
>    Copyright (c) 20XX, Acme Corporation. All rights reserved.<BR>
> -  This program and the accompanying materials
> -  are licensed and made available under the terms and conditions of
> -  the BSD License which accompanies this distribution. The full
> -  text of the license may be found at
> -  http://opensource.org/licenses/bsd-license.php
> -
> -  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS"
> -  BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER
> -  EXPRESS OR IMPLIED.
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
>  
>    @par Specification Reference:
>      - UEFI 2.3, Chapter 9, Device Path Protocol
> diff --git a/README.md b/README.md
> index 8b9675b..e261335 100644
> --- a/README.md
> +++ b/README.md
> @@ -112,3 +112,4 @@ Copyright (c) 2006-2017, Intel Corporation. All rights reserved.
>  | 2.1      | DRAFT for REFORMAT                                                                                                                                | 10/30/2015 |
>  | 2.2      | Convert to Gitbook                                                                                                                                | June 2017  |
>  |          | [#425](https://bugzilla.tianocore.org/show_bug.cgi?id=425) [CCS] clarify line breaking and indentation requirements for multi-line function calls |            |
> +|          | [#1656](https://bugzilla.tianocore.org/show_bug.cgi?id=1656) Update all Wiki pages for the BSD+Patent license change with SPDX identifiers        |            |
> diff --git a/appendix_a_common_examples.md b/appendix_a_common_examples.md
> index 1f247f3..d7b1a89 100644
> --- a/appendix_a_common_examples.md
> +++ b/appendix_a_common_examples.md
> @@ -40,14 +40,7 @@
>    Detailed description of file’s purpose.
>  
>    Copyright (c) 2006 - 2014, Acme Corporation. All rights reserved.<BR>
> -  This program and the accompanying materials
> -  are licensed and made available under the terms and conditions
> -  of the BSD License which accompanies this distribution. The full
> -  text of the license may be found at
> -  http://opensource.org/licenses/bsd-license.php
> -
> -  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> -  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
>  
>    @par Specification Reference:
>    - UEFI 2.3, Chapter 9, Device Path Protocol
>