Repository files navigation

A modern, feature-rich, cross-platform firmware developmentenvironment for the UEFI and PI specifications fromwww.uefi.org.

Host Type & Toolchain	Build Status	Test Status	Code Coverage
Windows_VS2019
Ubuntu_GCC5

More CI Build information

Toolchain	CONFIG	DEBUG	RELEASE	NOOPT
EmulatorPkg_Win_VS2019	IA32
	X64
	IA32 FULL
	X64 FULL
OvmfPkg_Win_VS2019	IA32
	X64
	IA32 X64
	IA32 X64 FULL

Toolchain	CONFIG	DEBUG	RELEASE	NOOPT
ArmVirtPkg_Ubuntu_GCC5	AARCH64
	ARM
EmulatorPkg_Ubuntu_GCC5	IA32
	X64
	IA32 FULL
	X64 FULL
OvmfPkg_Ubuntu_GCC5	IA32
	X64
	IA32 X64
	IA32 X64 FULL

- EmulatorPkg Ubuntu GCC5 Segfaults during execution.

- EmulatorPkg Ubuntu GCC5 Segfaults during execution.

More ArmVirtPkg CI Build Information

More EmulatorPkg CI Build Information

More OvmfPkg CI Build Information

The majority of the content in the EDK II open source project uses aBSD-2-Clause Plus Patent License. The EDK II opensource project contains the following components that are covered by additionallicenses:

• BaseTools/Source/C/LzmaCompress
• BaseTools/Source/C/VfrCompile/Pccts
• CryptoPkgLibraryBaseCryptLibSysCallinet_pton.c
• CryptoPkgLibraryIncludecryptodso_conf.h
• CryptoPkgLibraryIncludeopensslopensslconf.h
• EmbeddedPkg/Library/FdtLib. (EDK II uses BSD License)
• EmbeddedPkg/Include/fdt.h. (EDK II uses BSD Licence)
• EmbeddedPkg/Include/libfdt.h. (EDK II uses BSD License)
• MdeModulePkg/Library/LzmaCustomDecompressLib
• OvmfPkg

The EDK II open source project uses content from upstream projects as git submodulesthat are covered by additional licenses.

• ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3
• BaseTools/Source/C/BrotliCompress/brotli
• CryptoPkg/Library/OpensslLib/openssl
• MdeModulePkg/Library/BrotliCustomDecompressLib/brotli
• MdeModulePkg/Universal/RegularExpressionDxe/oniguruma
• UnitTestFrameworkPkg/Library/CmockaLib/cmocka
• UnitTestFrameworkPkg/Library/GoogleTestLib/googletest
• UnitTestFrameworkPkg/Library/SubhookLib/subhook
• RedfishPkg/Library/JsonLib/jansson
• MdePkg/Library/BaseFdtLib/libfdt
• MdePkg/Library/MipiSysTLib/mipisyst

The EDK II Project is composed of packages. The maintainers for each packageare listed inMaintainers.txt.

• TianoCore
• EDKII
• Getting Started with EDKII
• MailingLists
• TianoCore Bugzilla
• How ToContribute
• ReleasePlanning

To make a contribution to a TianoCore project, follow these steps.

1. Create a change description in the format specified below to

   use in the source control commit log.

2. Your commit message must include yourSigned-off-by signature

3. Submit your code to the TianoCore project using the process

   that the project documents on its web page. If the process isnot documented, then submit the code on development email listfor the project.

4. It is preferred that contributions are submitted using the same

   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

For documentation:

• FreeBSD Documentation License

  https://www.freebsd.org/copyright/freebsd-doc-license.html

Contributions of code put into the public domain can also be accepted.

Contributions using other licenses might be accepted, but furtherreview will be required.

Your change description should use the standard format for acommit message, and must include yourSigned-off-by signature.

In order to keep track of who did what, all patches contributed mustinclude a statement that to the best of the contributor's knowledgethey have the right to contribute it under the specified license.

The test for this is as specified in theDeveloper's Certificate ofOrigin (DCO) 1.1. The contributorcertifies compliance by adding a line saying

Signed-off-by: Developer Namedeveloper@example.org

whereDeveloper Name is the contributor's real name, and the emailaddress is one the developer is reachable through at the time ofcontributing.

Developer's Certificate of Origin 1.1By making a contribution to this project, I certify that:(a) The contribution was created in whole or in part by me and I    have the right to submit it under the open source license    indicated in the file; or(b) The contribution is based upon previous work that, to the best    of my knowledge, is covered under an appropriate open source    license and I have the right under that license to submit that    work with modifications, whether created in whole or in part    by me, under the same open source license (unless I am    permitted to submit under a different license), as indicated    in the file; or(c) The contribution was provided directly to me by some other    person who certified (a), (b) or (c) and I have not modified    it.(d) I understand and agree that this project and the contribution    are public and that a record of the contribution (including all    personal information I submit with it, including my sign-off) is    maintained indefinitely and may be redistributed consistent with    this project or the open source license(s) involved.

From: Contributor Name <contributor@example.com>Subject: [Repository/Branch PATCH] Pkg-Module: Brief-single-line-summaryFull-commit-messageSigned-off-by: Contributor Name <contributor@example.com>

• The first line of commit message is taken from the email's subjectline following[Repository/Branch PATCH]. The remaining portionof the commit message is the email's content.
• git format-patch is one way to create this format

• Repository is the identifier of the repository the patch applies.

  This identifier should only be provided for repositories other thanedk2. For exampleedk2-BuildSpecification orstaging.

• Branch is the identifier of the branch the patch applies. This

  identifier should only be provided for branches other than

  edk2/master.

  For exampleedk2/UDK2015,

  edk2-BuildSpecification/release/1.27, or

  staging/edk2-test.

• Module is a short identifier for the affected code ordocumentation. For exampleMdePkg,MdeModulePkg/UsbBusDxe,Introduction, or

  EDK II INF File Format.

• Brief-single-line-summary is a short summary of the change.

• The entire first line should be less than ~70 characters.

• Full-commit-message a verbose multiple line comment describing

  the change. Each line should be less than ~70 characters.

• Signed-off-by is the contributor's signature identifying them

  by their real/legal name and their email address.

Submodule in EDK II is allowed but submodule chain should be avoidedas 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 inevitablein openssl-1.1.1 (since stable201905) for floating point parameterconversion, but should be dropped once there's no such need in futurerelease of openssl.

To get a full, buildable EDK II repository, use following steps of gitcommand

git clone https://github.com/tianocore/edk2.gitcd edk2git submodule update --initcd ..

If there's update for submodules, use following git commands to getthe latest submodules code.

cd edk2git pullgit submodule update

Note: When cloning submodule repos, '--recursive' option is notrecommended. EDK II itself will not use any code/feature fromsubmodules in above submodules. So using '--recursive' adds adependency on being able to reach servers we do not actually wantany code from, as well as needlessly downloading code we will notuse.