--- /dev/null
+==============\r
+EDK II Project\r
+==============\r
+\r
+A modern, feature-rich, cross-platform firmware development\r
+environment for the UEFI and PI specifications from www.uefi.org.\r
+\r
+Core CI Build Status\r
+--------------------\r
+\r
+============================= ================= =============== ===================\r
+ Host Type & Toolchain Build Status Test Status Code Coverage\r
+============================= ================= =============== ===================\r
+Windows_VS2019_ |WindowsCiBuild| |WindowsCiTest| |WindowsCiCoverage|\r
+Ubuntu_GCC5_ |UbuntuCiBuild| |UbuntuCiTest| |UbuntuCiCoverage|\r
+============================= ================= =============== ===================\r
+\r
+`More CI Build information <.pytool/Readme.md>`__\r
+\r
+Platform CI Build Status\r
+------------------------\r
+\r
+Microsoft Windows VS2019\r
+````````````````````````\r
+\r
+============================= ================= ============= ============= ==============\r
+ Toolchain CONFIG DEBUG RELEASE NOOPT\r
+============================= ================= ============= ============= ==============\r
+EmulatorPkg_Win_VS2019_ | IA32 |em32d| |em32r| |em32n|\r
+| | X64 |em64d| |em64r| |em64n|\r
+OvmfPkg_Win_VS2019_ | IA32 |op32d| |op32r| |op32n|\r
+| | X64 |op64d| |op64r| |op64n|\r
+| | IA32 X64 |op3264d| |op3264r| |op3264n|\r
+| | IA32 X64 FULL |op3264fd| |op3264fr| |op3264fn|\r
+============================= ================= ============= ============= ==============\r
+\r
+Ubuntu 18.04 GCC5\r
+`````````````````\r
+\r
+============================= ================= ============= ============= ==============\r
+ Toolchain CONFIG DEBUG RELEASE NOOPT\r
+============================= ================= ============= ============= ==============\r
+ArmVirtPkg_Ubuntu_GCC5_ | AARCH64 |avAArch64du| |avAArch64ru| |avAArch64nu|\r
+| | ARM |avArmdu| |avArmru| |avArmnu|\r
+EmulatorPkg_Ubuntu_GCC5_ | IA32 |em32du| |em32ru| |em32nu|\r
+| | X64 |em64du| |em64ru| |em64nu|\r
+OvmfPkg_Ubuntu_GCC5_ | IA32 |op32du| |op32ru| |op32nu|\r
+| | X64 |op64du| |op64ru| |op64nu|\r
+| | IA32 X64 |op3264du| |op3264ru| |op3264nu|\r
+| | IA32 X64 FULL |op3264fdu| |op3264fru| |op3264fru|\r
+============================= ================= ============= ============= ==============\r
+\r
+|TCBZ_2668|_ - EmulatorPkg Ubuntu GCC5 Segfaults during execution.\r
+\r
+|TCBZ_2639|_ - EmulatorPkg Ubuntu GCC5 Segfaults during execution.\r
+\r
+`More ArmVirtPkg CI Build Information <ArmVirtPkg/PlatformCI/ReadMe.md>`__\r
+\r
+`More EmulatorPkg CI Build Information <EmulatorPkg/PlatformCI/ReadMe.md>`__\r
+\r
+`More OvmfPkg CI Build Information <OvmfPkg/PlatformCI/ReadMe.md>`__\r
+\r
+\r
+License Details\r
+---------------\r
+\r
+The majority of the content in the EDK II open source project uses a\r
+`BSD-2-Clause Plus Patent License <License.txt>`__. The EDK II open\r
+source project contains the following components that are covered by additional\r
+licenses:\r
+\r
+- `BaseTools/Source/C/BrotliCompress/brotli <https://github.com/google/brotli/blob/master/LICENSE>`__\r
+- `MdeModulePkg/Library/BrotliCustomDecompressLib/brotli <https://github.com/google/brotli/blob/master/LICENSE>`__\r
+- `BaseTools/Source/C/LzmaCompress <BaseTools/Source/C/LzmaCompress/LZMA-SDK-README.txt>`__\r
+- `MdeModulePkg/Library/LzmaCustomDecompressLib <MdeModulePkg/Library/LzmaCustomDecompressLib/LZMA-SDK-README.txt>`__\r
+- `IntelFrameworkModulePkg/Library/LzmaCustomDecompressLib/Sdk <IntelFrameworkModulePkg/Library/LzmaCustomDecompressLib/LZMA-SDK-README.txt>`__\r
+- `BaseTools/Source/C/VfrCompile/Pccts <BaseTools/Source/C/VfrCompile/Pccts/RIGHTS>`__\r
+- `MdeModulePkg/Universal/RegularExpressionDxe/oniguruma <https://github.com/kkos/oniguruma/blob/master/README.md>`__\r
+- `OvmfPkg <OvmfPkg/License.txt>`__\r
+- `CryptoPkg/Library/OpensslLib/openssl <https://github.com/openssl/openssl/blob/50eaac9f3337667259de725451f201e784599687/LICENSE>`__\r
+- `ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3 <https://github.com/ucb-bar/berkeley-softfloat-3/blob/b64af41c3276f97f0e181920400ee056b9c88037/COPYING.txt>`__\r
+\r
+The EDK II Project is composed of packages. The maintainers for each package\r
+are listed in `Maintainers.txt <Maintainers.txt>`__.\r
+\r
+Resources\r
+---------\r
+\r
+- `TianoCore <http://www.tianocore.org>`__\r
+- `EDK\r
+ II <https://github.com/tianocore/tianocore.github.io/wiki/EDK-II>`__\r
+- `Getting Started with EDK\r
+ II <https://github.com/tianocore/tianocore.github.io/wiki/Getting-Started-with-EDK-II>`__\r
+- `Mailing\r
+ Lists <https://github.com/tianocore/tianocore.github.io/wiki/Mailing-Lists>`__\r
+- `TianoCore Bugzilla <https://bugzilla.tianocore.org>`__\r
+- `How To\r
+ Contribute <https://github.com/tianocore/tianocore.github.io/wiki/How-To-Contribute>`__\r
+- `Release\r
+ Planning <https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Release-Planning>`__\r
+\r
+Code Contributions\r
+------------------\r
+\r
+To make a contribution to a TianoCore project, follow these steps.\r
+\r
+#. Create a change description in the format specified below to\r
+ use in the source control commit log.\r
+#. Your commit message must include your ``Signed-off-by`` signature\r
+#. Submit your code to the TianoCore project using the process\r
+ that the project documents on its web page. If the process is\r
+ not documented, then submit the code on development email list\r
+ for the project.\r
+#. It is preferred that contributions are submitted using the same\r
+ copyright license as the base project. When that is not possible,\r
+ then contributions using the following licenses can be accepted:\r
+\r
+- BSD (2-clause): http://opensource.org/licenses/BSD-2-Clause\r
+- BSD (3-clause): http://opensource.org/licenses/BSD-3-Clause\r
+- MIT: http://opensource.org/licenses/MIT\r
+- Python-2.0: http://opensource.org/licenses/Python-2.0\r
+- Zlib: http://opensource.org/licenses/Zlib\r
+\r
+For documentation:\r
+\r
+- FreeBSD Documentation License\r
+ https://www.freebsd.org/copyright/freebsd-doc-license.html\r
+\r
+Contributions of code put into the public domain can also be accepted.\r
+\r
+Contributions using other licenses might be accepted, but further\r
+review will be required.\r
+\r
+Developer Certificate of Origin\r
+-------------------------------\r
+\r
+Your change description should use the standard format for a\r
+commit message, and must include your ``Signed-off-by`` signature.\r
+\r
+In order to keep track of who did what, all patches contributed must\r
+include a statement that to the best of the contributor's knowledge\r
+they have the right to contribute it under the specified license.\r
+\r
+The test for this is as specified in the `Developer's Certificate of\r
+Origin (DCO) 1.1 <https://developercertificate.org/>`__. The contributor\r
+certifies compliance by adding a line saying\r
+\r
+Signed-off-by: Developer Name developer@example.org\r
+\r
+where ``Developer Name`` is the contributor's real name, and the email\r
+address is one the developer is reachable through at the time of\r
+contributing.\r
+\r
+::\r
+\r
+ Developer's Certificate of Origin 1.1\r
+\r
+ By making a contribution to this project, I certify that:\r
+\r
+ (a) The contribution was created in whole or in part by me and I\r
+ have the right to submit it under the open source license\r
+ indicated in the file; or\r
+\r
+ (b) The contribution is based upon previous work that, to the best\r
+ of my knowledge, is covered under an appropriate open source\r
+ license and I have the right under that license to submit that\r
+ work with modifications, whether created in whole or in part\r
+ by me, under the same open source license (unless I am\r
+ permitted to submit under a different license), as indicated\r
+ in the file; or\r
+\r
+ (c) The contribution was provided directly to me by some other\r
+ person who certified (a), (b) or (c) and I have not modified\r
+ it.\r
+\r
+ (d) I understand and agree that this project and the contribution\r
+ are public and that a record of the contribution (including all\r
+ personal information I submit with it, including my sign-off) is\r
+ maintained indefinitely and may be redistributed consistent with\r
+ this project or the open source license(s) involved.\r
+\r
+Sample Change Description / Commit Message\r
+------------------------------------------\r
+\r
+::\r
+\r
+ From: Contributor Name <contributor@example.com>\r
+ Subject: [Repository/Branch PATCH] Pkg-Module: Brief-single-line-summary\r
+\r
+ Full-commit-message\r
+\r
+ Signed-off-by: Contributor Name <contributor@example.com>\r
+\r
+Notes for sample patch email\r
+````````````````````````````\r
+\r
+- The first line of commit message is taken from the email's subject\r
+ line following ``[Repository/Branch PATCH]``. The remaining portion\r
+ of the commit message is the email's content.\r
+- ``git format-patch`` is one way to create this format\r
+\r
+Definitions for sample patch email\r
+``````````````````````````````````\r
+\r
+- ``Repository`` is the identifier of the repository the patch applies.\r
+ This identifier should only be provided for repositories other than\r
+ ``edk2``. For example ``edk2-BuildSpecification`` or ``staging``.\r
+- ``Branch`` is the identifier of the branch the patch applies. This\r
+ identifier should only be provided for branches other than\r
+ ``edk2/master``.\r
+ For example ``edk2/UDK2015``,\r
+ ``edk2-BuildSpecification/release/1.27``, or\r
+ ``staging/edk2-test``.\r
+- ``Module`` is a short identifier for the affected code or\r
+ documentation. For example ``MdePkg``, ``MdeModulePkg/UsbBusDxe``, ``Introduction``, or\r
+ ``EDK II INF File Format``.\r
+- ``Brief-single-line-summary`` is a short summary of the change.\r
+- The entire first line should be less than ~70 characters.\r
+- ``Full-commit-message`` a verbose multiple line comment describing\r
+ the change. Each line should be less than ~70 characters.\r
+- ``Signed-off-by`` is the contributor's signature identifying them\r
+ by their real/legal name and their email address.\r
+\r
+Submodules\r
+----------\r
+\r
+Submodule in EDK II is allowed but submodule chain should be avoided\r
+as possible as we can. Currently EDK II contains the following submodules\r
+\r
+- CryptoPkg/Library/OpensslLib/openssl\r
+- ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3\r
+- MdeModulePkg/Universal/RegularExpressionDxe/oniguruma\r
+- MdeModulePkg/Library/BrotliCustomDecompressLib/brotli\r
+- BaseTools/Source/C/BrotliCompress/brotli\r
+\r
+ArmSoftFloatLib is actually required by OpensslLib. It's inevitable\r
+in openssl-1.1.1 (since stable201905) for floating point parameter\r
+conversion, but should be dropped once there's no such need in future\r
+release of openssl.\r
+\r
+To get a full, buildable EDK II repository, use following steps of git\r
+command\r
+\r
+.. code-block:: bash\r
+\r
+ git clone https://github.com/tianocore/edk2.git\r
+ cd edk2\r
+ git submodule update --init\r
+ cd ..\r
+\r
+If there's update for submodules, use following git commands to get\r
+the latest submodules code.\r
+\r
+.. code-block:: bash\r
+\r
+ cd edk2\r
+ git pull\r
+ git submodule update\r
+\r
+Note: When cloning submodule repos, '--recursive' option is not\r
+recommended. EDK II itself will not use any code/feature from\r
+submodules in above submodules. So using '--recursive' adds a\r
+dependency on being able to reach servers we do not actually want\r
+any code from, as well as needlessly downloading code we will not\r
+use.\r
+\r
+.. ===================================================================\r
+.. This is a bunch of directives to make the README file more readable\r
+.. ===================================================================\r
+\r
+.. CoreCI\r
+\r
+.. _Windows_VS2019: https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=32&branchName=master\r
+.. |WindowsCiBuild| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/Windows%20VS2019%20CI?branchName=master\r
+.. |WindowsCiTest| image:: https://img.shields.io/azure-devops/tests/tianocore/edk2-ci/32.svg\r
+.. |WindowsCiCoverage| image:: https://img.shields.io/badge/coverage-coming_soon-blue\r
+\r
+.. _Ubuntu_GCC5: https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=31&branchName=master\r
+.. |UbuntuCiBuild| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/Ubuntu%20GCC5%20CI?branchName=master\r
+.. |UbuntuCiTest| image:: https://img.shields.io/azure-devops/tests/tianocore/edk2-ci/31.svg\r
+.. |UbuntuCiCoverage| image:: https://img.shields.io/badge/coverage-coming_soon-blue\r
+\r
+.. ArmVirtPkg\r
+\r
+.. _ArmVirtPkg_Ubuntu_GCC5: https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=46&branchName=master\r
+.. |avAArch64du| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_ArmVirtPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20QEMU_AARCH64_DEBUG\r
+.. |avAArch64ru| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_ArmVirtPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20QEMU_AARCH64_RELEASE\r
+.. |avAArch64nu| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_ArmVirtPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20QEMU_AARCH64_NOOPT\r
+\r
+.. |avArmdu| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_ArmVirtPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20QEMU_ARM_DEBUG\r
+.. |avArmru| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_ArmVirtPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20QEMU_ARM_RELEASE\r
+.. |avArmnu| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_ArmVirtPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20QEMU_ARM_NOOPT\r
+\r
+.. EmulatorPkg\r
+\r
+.. |TCBZ_2668| image:: https://img.shields.io/bugzilla/2668?baseUrl=https%3A%2F%2Fbugzilla.tianocore.org\r
+.. _TCBZ_2668: https://bugzilla.tianocore.org/show_bug.cgi?id=2668\r
+\r
+.. |TCBZ_2639| image:: https://img.shields.io/bugzilla/2639?baseUrl=https%3A%2F%2Fbugzilla.tianocore.org\r
+.. _TCBZ_2639: https://bugzilla.tianocore.org/show_bug.cgi?id=2639\r
+\r
+.. _EmulatorPkg_Win_VS2019: https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=44&branchName=master\r
+.. _EmulatorPkg_Ubuntu_GCC5: https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=43&branchName=master\r
+\r
+.. |em32d| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_EmulatorPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_IA32_DEBUG\r
+.. |em32du| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_EmulatorPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_IA32_DEBUG\r
+.. |em32r| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_EmulatorPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_IA32_RELEASE\r
+.. |em32ru| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_EmulatorPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_IA32_RELEASE\r
+.. |em32n| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_EmulatorPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_IA32_NOOPT\r
+.. |em32nu| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_EmulatorPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_IA32_NOOPT\r
+\r
+.. |em64d| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_EmulatorPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_X64_DEBUG\r
+.. |em64du| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_EmulatorPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_X64_DEBUG\r
+.. |em64r| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_EmulatorPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_X64_RELEASE\r
+.. |em64ru| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_EmulatorPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_X64_RELEASE\r
+.. |em64n| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_EmulatorPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_X64_NOOPT\r
+.. |em64nu| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_EmulatorPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_X64_NOOPT\r
+\r
+.. OvmfPkg\r
+\r
+.. |TCBZ_2661| image:: https://img.shields.io/bugzilla/2661?baseUrl=https%3A%2F%2Fbugzilla.tianocore.org\r
+.. _TCBZ_2661: https://bugzilla.tianocore.org/show_bug.cgi?id=2661\r
+\r
+.. _OvmfPkg_Win_VS2019: https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=50&branchName=master\r
+.. _OvmfPkg_Ubuntu_GCC5: https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=48&branchName=master\r
+\r
+.. |op32d| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32_DEBUG\r
+.. |op32du| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32_DEBUG\r
+.. |op32r| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32_RELEASE\r
+.. |op32ru| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32_RELEASE\r
+.. |op32n| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32_NOOPT\r
+.. |op32nu| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32_NOOPT\r
+\r
+.. |op64d| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_X64_DEBUG\r
+.. |op64du| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_X64_DEBUG\r
+.. |op64r| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_X64_RELEASE\r
+.. |op64ru| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_X64_RELEASE\r
+.. |op64n| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_X64_NOOPT\r
+.. |op64nu| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_X64_NOOPT\r
+\r
+\r
+.. |op3264d| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_DEBUG\r
+.. |op3264du| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_DEBUG\r
+.. |op3264r| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_RELEASE\r
+.. |op3264ru| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_RELEASE\r
+.. |op3264n| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_NOOPT\r
+.. |op3264nu| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_NOOPT\r
+\r
+.. |op3264fd| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_FULL_DEBUG\r
+.. |op3264fdu| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_FULL_DEBUG\r
+.. |op3264fr| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Windows_VS2019_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_FULL_RELEASE\r
+.. |op3264fru| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_FULL_RELEASE\r
+.. |op3264fn| replace:: |TCBZ_2661|_\r
+.. |op3264fnu| image:: https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/PlatformCI_OvmfPkg_Ubuntu_GCC5_CI?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_FULL_NOOPT\r
+++ /dev/null
-# EDK II Project\r
-\r
-A modern, feature-rich, cross-platform firmware development environment\r
-for the UEFI and PI specifications from www.uefi.org.\r
-\r
-# Build Status\r
-\r
-<table>\r
- <tr>\r
- <th>Host Type</th>\r
- <th>Toolchain</th>\r
- <th>Branch</th>\r
- <th>Build Status</th>\r
- <th>Test Status</th>\r
- <th>Code Coverage</th>\r
- </tr>\r
- <tr>\r
- <td>Windows</td>\r
- <td>VS2019</td>\r
- <td>master</td>\r
- <td>\r
- <a href="https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=32&branchName=master">\r
- <img src="https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/Windows%20VS2019%20CI?branchName=master"/></a>\r
- </td>\r
- <td>\r
- <a href="https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=32&branchName=master">\r
- <img src="https://img.shields.io/azure-devops/tests/tianocore/edk2-ci/32.svg"/></a>\r
- </td>\r
- <td>\r
- <a href="https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=32&branchName=master">\r
- <img src="https://img.shields.io/badge/coverage-coming_soon-blue"/></a>\r
- </td>\r
- </tr>\r
- <tr>\r
- <td>Ubuntu</td>\r
- <td>GCC</td>\r
- <td>master</td>\r
- <td>\r
- <a href="https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=31&branchName=master">\r
- <img src="https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/Ubuntu%20GCC5%20CI?branchName=master"/></a>\r
- </td>\r
- <td>\r
- <a href="https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=31&branchName=master">\r
- <img src="https://img.shields.io/azure-devops/tests/tianocore/edk2-ci/31.svg"/></a>\r
- </td>\r
- <td>\r
- <a href="https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=31&branchName=master">\r
- <img src="https://img.shields.io/badge/coverage-coming_soon-blue"/></a>\r
- </td>\r
- </tr>\r
-</table>\r
-\r
-[More CI Build information](.pytool/Readme.md)\r
-\r
-# License Details\r
-\r
-The majority of the content in the EDK II open source project uses a\r
-[BSD-2-Clause Plus Patent License](License.txt). The EDK II open source project\r
-contains the following components that are covered by additional licenses:\r
-* [BaseTools/Source/C/BrotliCompress/brotli](https://github.com/google/brotli/blob/master/LICENSE)\r
-* [MdeModulePkg/Library/BrotliCustomDecompressLib/brotli](https://github.com/google/brotli/blob/master/LICENSE)\r
-* [BaseTools/Source/C/LzmaCompress](BaseTools/Source/C/LzmaCompress/LZMA-SDK-README.txt)\r
-* [MdeModulePkg/Library/LzmaCustomDecompressLib](MdeModulePkg/Library/LzmaCustomDecompressLib/LZMA-SDK-README.txt)\r
-* [IntelFrameworkModulePkg/Library/LzmaCustomDecompressLib/Sdk](IntelFrameworkModulePkg/Library/LzmaCustomDecompressLib/LZMA-SDK-README.txt)\r
-* [BaseTools/Source/C/VfrCompile/Pccts](BaseTools/Source/C/VfrCompile/Pccts/RIGHTS)\r
-* [MdeModulePkg/Universal/RegularExpressionDxe/oniguruma](https://github.com/kkos/oniguruma/blob/master/README.md)\r
-* [OvmfPkg](OvmfPkg/License.txt)\r
-* [CryptoPkg/Library/OpensslLib/openssl](https://github.com/openssl/openssl/blob/50eaac9f3337667259de725451f201e784599687/LICENSE)\r
-* [ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3](https://github.com/ucb-bar/berkeley-softfloat-3/blob/b64af41c3276f97f0e181920400ee056b9c88037/COPYING.txt)\r
-\r
-The EDK II Project is composed of packages. The maintainers for each package\r
-are listed in [Maintainers.txt](Maintainers.txt).\r
-\r
-# Resources\r
-* [TianoCore](http://www.tianocore.org)\r
-* [EDK II](https://github.com/tianocore/tianocore.github.io/wiki/EDK-II)\r
-* [Getting Started with EDK II](https://github.com/tianocore/tianocore.github.io/wiki/Getting-Started-with-EDK-II)\r
-* [Mailing Lists](https://github.com/tianocore/tianocore.github.io/wiki/Mailing-Lists)\r
-* [TianoCore Bugzilla](https://bugzilla.tianocore.org)\r
-* [How To Contribute](https://github.com/tianocore/tianocore.github.io/wiki/How-To-Contribute)\r
-* [Release Planning](https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Release-Planning)\r
-\r
-# Code Contributions\r
-To make a contribution to a TianoCore project, follow these steps.\r
-1. Create a change description in the format specified below to\r
- use in the source control commit log.\r
-2. Your commit message must include your `Signed-off-by` signature\r
-3. Submit your code to the TianoCore project using the process\r
- that the project documents on its web page. If the process is\r
- not documented, then submit the code on development email list\r
- for the project.\r
-4. It is preferred that contributions are submitted using the same\r
- copyright license as the base project. When that is not possible,\r
- then contributions using the following licenses can be accepted:\r
- * BSD (2-clause): http://opensource.org/licenses/BSD-2-Clause\r
- * BSD (3-clause): http://opensource.org/licenses/BSD-3-Clause\r
- * MIT: http://opensource.org/licenses/MIT\r
- * Python-2.0: http://opensource.org/licenses/Python-2.0\r
- * Zlib: http://opensource.org/licenses/Zlib\r
-\r
- For documentation:\r
- * FreeBSD Documentation License\r
- https://www.freebsd.org/copyright/freebsd-doc-license.html\r
-\r
- Contributions of code put into the public domain can also be\r
- accepted.\r
-\r
- Contributions using other licenses might be accepted, but further\r
- review will be required.\r
-\r
-# Developer Certificate of Origin\r
-\r
-Your change description should use the standard format for a\r
-commit message, and must include your `Signed-off-by` signature.\r
-\r
-In order to keep track of who did what, all patches contributed must\r
-include a statement that to the best of the contributor's knowledge\r
-they have the right to contribute it under the specified license.\r
-\r
-The test for this is as specified in the [Developer's Certificate of\r
-Origin (DCO) 1.1](https://developercertificate.org/). The contributor\r
-certifies compliance by adding a line saying\r
-\r
- Signed-off-by: Developer Name <developer@example.org>\r
-\r
-where `Developer Name` is the contributor's real name, and the email\r
-address is one the developer is reachable through at the time of\r
-contributing.\r
-\r
-```\r
-Developer's Certificate of Origin 1.1\r
-\r
-By making a contribution to this project, I certify that:\r
-\r
-(a) The contribution was created in whole or in part by me and I\r
- have the right to submit it under the open source license\r
- indicated in the file; or\r
-\r
-(b) The contribution is based upon previous work that, to the best\r
- of my knowledge, is covered under an appropriate open source\r
- license and I have the right under that license to submit that\r
- work with modifications, whether created in whole or in part\r
- by me, under the same open source license (unless I am\r
- permitted to submit under a different license), as indicated\r
- in the file; or\r
-\r
-(c) The contribution was provided directly to me by some other\r
- person who certified (a), (b) or (c) and I have not modified\r
- it.\r
-\r
-(d) I understand and agree that this project and the contribution\r
- are public and that a record of the contribution (including all\r
- personal information I submit with it, including my sign-off) is\r
- maintained indefinitely and may be redistributed consistent with\r
- this project or the open source license(s) involved.\r
-```\r
-\r
-# Sample Change Description / Commit Message\r
-\r
-```\r
-From: Contributor Name <contributor@example.com>\r
-Subject: [Repository/Branch PATCH] Pkg-Module: Brief-single-line-summary\r
-\r
-Full-commit-message\r
-\r
-Signed-off-by: Contributor Name <contributor@example.com>\r
-```\r
-\r
-## Notes for sample patch email\r
-\r
-* The first line of commit message is taken from the email's subject\r
- line following `[Repository/Branch PATCH]`. The remaining portion of the\r
- commit message is the email's content.\r
-* `git format-patch` is one way to create this format\r
-\r
-## Definitions for sample patch email\r
-\r
-* `Repository` is the identifier of the repository the patch applies.\r
- This identifier should only be provided for repositories other than\r
- `edk2`. For example `edk2-BuildSpecification` or `staging`.\r
-* `Branch` is the identifier of the branch the patch applies. This\r
- identifier should only be provided for branches other than `edk2/master`.\r
- For example `edk2/UDK2015`, `edk2-BuildSpecification/release/1.27`, or\r
- `staging/edk2-test`.\r
-* `Module` is a short identifier for the affected code or documentation. For\r
- example `MdePkg`, `MdeModulePkg/UsbBusDxe`, `Introduction`, or\r
- `EDK II INF File Format`.\r
-* `Brief-single-line-summary` is a short summary of the change.\r
-* The entire first line should be less than ~70 characters.\r
-* `Full-commit-message` a verbose multiple line comment describing\r
- the change. Each line should be less than ~70 characters.\r
-* `Signed-off-by` is the contributor's signature identifying them\r
- by their real/legal name and their email address.\r
-\r
-# Submodules\r
-\r
-Submodule in EDK II is allowed but submodule chain should be avoided\r
-as possible as we can. Currently EDK II contains the following submodules\r
-\r
-- CryptoPkg/Library/OpensslLib/openssl\r
-- ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3\r
-- MdeModulePkg/Universal/RegularExpressionDxe/oniguruma\r
-- MdeModulePkg/Library/BrotliCustomDecompressLib/brotli\r
-- BaseTools/Source/C/BrotliCompress/brotli\r
-\r
-ArmSoftFloatLib is actually required by OpensslLib. It's inevitable\r
-in openssl-1.1.1 (since stable201905) for floating point parameter\r
-conversion, but should be dropped once there's no such need in future\r
-release of openssl.\r
-\r
-To get a full, buildable EDK II repository, use following steps of git\r
-command\r
-\r
-```\r
-$ git clone https://github.com/tianocore/edk2.git\r
-$ cd edk2\r
-$ git submodule update --init\r
-$ cd ..\r
-```\r
-\r
-If there's update for submodules, use following git commands to get the\r
-latest submodules code.\r
-\r
-```\r
-$ cd edk2\r
-$ git pull\r
-$ git submodule update\r
-```\r
-\r
-Note: When cloning submodule repos, '--recursive' option is not\r
-recommended. EDK II itself will not use any code/feature from\r
-submodules in above submodules. So using '--recursive' adds a\r
-dependency on being able to reach servers we do not actually want\r
-any code from, as well as needlessly downloading code we will not\r
-use.\r
projects / mirror_edk2.git / commitdiff