From: Michael Kubacki <michael.kuba...@microsoft.com> This series adds a new set of build instructions and updates prior instructions to point to the new version.
Background ---------- Over the life of the project, EDK II has evolved it's build process. A common theme has been reducing the number of manual steps involved and easing environment setup and configuration so developers can more quickly get started writing firmware code. There's currently three general approaches to build: 1. [Containers](How-to-Develop-With-Containers.md) 2. [Stuart](How-to-Build-With-Stuart.md) 3. [build](Getting-Started-with-EDK-II.mediawiki) Prior documentation focuses on directly calling build (3). The new documentation focuses on (1) and (2) but all of the instructions for (3) are left intact. This is especially important given the transition to container based builds on CI and introduction of more CI checks. Changes ------- Adds new documentation that describes containers and how to manually set up a build environment using Stuart. Containers document covers: - Container background - Docker background and installation - Local development with containers - How to manually configure a container - Integration with VS Code - Containers in pipelines Stuart build background covers: - Pre-requisites - Git, Python, compilers, SDKs, etc. - Initial steps - Cloning the repo, set up Python virtual env, etc. - Stuart command explanation and corresponding examples - Common developer scenarios with examples showing what to do - Common questions section with answers In addition, a "top-level" document is added that is main landing page for references to build instructions that briefly describes the three approaches with links to each. This is starting material for these topics, we plan to work with the community to evolve them over time. Cc: Sean Brogan <sean.bro...@microsoft.com> Cc: Michael D Kinney <michael.d.kin...@intel.com> Cc: Liming Gao <gaolim...@byosoft.com.cn> Cc: Chris Fernald <chrisf...@gmail.com> Signed-off-by: Michael Kubacki <michael.kuba...@microsoft.com> Chris Fernald (1): Add initial container usage instructions Michael Kubacki (3): Add initial How to Build with Stuart Document Add top-level build instructions file Update existing build instructions Build-Instructions.md | 35 + Build.mediawiki | 33 +- BuildTool-Setup-Guide.mediawiki | 19 +- Common-instructions-for-Unix.mediawiki | 7 +- Common-instructions.mediawiki | 5 + Getting-Started-with-EDK-II.mediawiki | 16 +- How-to-Build-With-Stuart.md | 720 ++++++++++++++++++++ How-to-Develop-With-Containers.md | 120 ++++ UDK2017-How-to-Build.md | 30 +- UDK2018-How-to-Build.md | 34 +- Unix-like-systems.mediawiki | 7 +- Using-EDK-II-with-Native-GCC.mediawiki | 13 +- Windows-systems.mediawiki | 26 +- 13 files changed, 993 insertions(+), 72 deletions(-) create mode 100644 Build-Instructions.md create mode 100644 How-to-Build-With-Stuart.md create mode 100644 How-to-Develop-With-Containers.md -- 2.28.0.windows.1 -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#96962): https://edk2.groups.io/g/devel/message/96962 Mute This Topic: https://groups.io/mt/95472124/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
