Skip to content

Commit

Permalink
ReadMe.rst: Add Apache License 2.0 and update submodule list
Browse files Browse the repository at this point in the history
- Adds Apache License 2.0 as an acceptable source license per
  discussion in https://edk2.groups.io/g/devel/message/110226
- Updates the URL for existing licenses to match the current path
  used by opensource.org.
- The submodule list in this file is stale and is very prone to
  being forgotten. The list of submodules in the submodules setion
  is replaced with a link to .gitmodules which has an active list
  of submodules at any given time.

Cc: Andrew Fish <afish@apple.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Pedro Falcato <pedro.falcato@gmail.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
Acked-by: Pedro Falcato <pedro.falcato@gmail.com>
  • Loading branch information
makubacki authored and mergify[bot] committed Nov 2, 2023
1 parent fbbbd98 commit 8da978b
Showing 1 changed file with 13 additions and 18 deletions.
31 changes: 13 additions & 18 deletions ReadMe.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,12 @@ To make a contribution to a TianoCore project, follow these steps.
copyright license as the base project. When that is not possible,
then contributions using the following licenses can be accepted:

- BSD (2-clause): http://opensource.org/licenses/BSD-2-Clause
- BSD (3-clause): http://opensource.org/licenses/BSD-3-Clause
- MIT: http://opensource.org/licenses/MIT
- Python-2.0: http://opensource.org/licenses/Python-2.0
- Zlib: http://opensource.org/licenses/Zlib
- Apache License, Version 2.0: https://opensource.org/license/apache-2-0/
- BSD (2-clause): https://opensource.org/license/BSD-2-Clause
- BSD (3-clause): https://opensource.org/license/BSD-3-Clause
- MIT: https://opensource.org/license/MIT
- Python-2.0: https://opensource.org/license/Python-2.0
- Zlib: https://opensource.org/license/Zlib

For documentation:

Expand Down Expand Up @@ -243,19 +244,7 @@ Definitions for sample patch email
Submodules
----------

Submodule in EDK II is allowed but submodule chain should be avoided
as possible as we can. Currently EDK II contains the following submodules

- CryptoPkg/Library/OpensslLib/openssl
- ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3
- MdeModulePkg/Universal/RegularExpressionDxe/oniguruma
- MdeModulePkg/Library/BrotliCustomDecompressLib/brotli
- BaseTools/Source/C/BrotliCompress/brotli

ArmSoftFloatLib is actually required by OpensslLib. It's inevitable
in openssl-1.1.1 (since stable201905) for floating point parameter
conversion, but should be dropped once there's no such need in future
release of openssl.
The current submodules used in EDK II are in `.gitmodules <.gitmodules>`__.

To get a full, buildable EDK II repository, use following steps of git
command
Expand Down Expand Up @@ -283,6 +272,12 @@ dependency on being able to reach servers we do not actually want
any code from, as well as needlessly downloading code we will not
use.

**Submodule Notes**

ArmSoftFloatLib is required by OpensslLib. It's inevitable in openssl-1.1.1
(since stable201905) for floating point parameter conversion, but should be
dropped once there's no such need in future release of openssl.

.. ===================================================================
.. This is a bunch of directives to make the README file more readable
.. ===================================================================
Expand Down

0 comments on commit 8da978b

Please sign in to comment.