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
From: Michael Kubacki <michael.kubacki@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.brogan@microsoft.com> Cc: Michael D Kinney <michael.d.kinney@intel.com> Cc: Liming Gao <gaoliming@byosoft.com.cn> Cc: Chris Fernald <chrisf671@gmail.com> Signed-off-by: Michael Kubacki <michael.kubacki@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/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=-=-=-=-=-=-=-=-=-=-=-
Messages 1/4 and 4/4 are empty, and 2/4 seems to be missing. -- Rebecca Cran On 12/5/22 09:15, Michael Kubacki wrote: > From: Michael Kubacki <michael.kubacki@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.brogan@microsoft.com> > Cc: Michael D Kinney <michael.d.kinney@intel.com> > Cc: Liming Gao <gaoliming@byosoft.com.cn> > Cc: Chris Fernald <chrisf671@gmail.com> > Signed-off-by: Michael Kubacki <michael.kubacki@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 > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#96967): https://edk2.groups.io/g/devel/message/96967 Mute This Topic: https://groups.io/mt/95472124/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=-=-=-=-=-=-=-=-=-=-=-
Thanks, I'm working on it. On 12/5/2022 11:25 AM, Rebecca Cran wrote: > Messages 1/4 and 4/4 are empty, and 2/4 seems to be missing. > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#96968): https://edk2.groups.io/g/devel/message/96968 Mute This Topic: https://groups.io/mt/95472124/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=-=-=-=-=-=-=-=-=-=-=-
2/4 just came through. On 12/5/22 09:26, Michael Kubacki wrote: > Thanks, I'm working on it. > > On 12/5/2022 11:25 AM, Rebecca Cran wrote: >> Messages 1/4 and 4/4 are empty, and 2/4 seems to be missing. >> > > > > > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#96969): https://edk2.groups.io/g/devel/message/96969 Mute This Topic: https://groups.io/mt/95472124/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=-=-=-=-=-=-=-=-=-=-=-
I'm still trying to determine what to change for this particular series to look correct on the mailing list. In the meantime, if you want to see it, it is available here on my fork: https://github.com/makubacki/tianocore.github.io/commits/add_stuart_build_instructions Thanks, Michael On 12/5/2022 11:26 AM, Rebecca Cran wrote: > 2/4 just came through. > > On 12/5/22 09:26, Michael Kubacki wrote: >> Thanks, I'm working on it. >> >> On 12/5/2022 11:25 AM, Rebecca Cran wrote: >>> Messages 1/4 and 4/4 are empty, and 2/4 seems to be missing. >>> >> >> >> >> >> > > > > > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#96978): https://edk2.groups.io/g/devel/message/96978 Mute This Topic: https://groups.io/mt/95472124/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=-=-=-=-=-=-=-=-=-=-=-
Thanks. I don't see any mention of needing mono on Linux - so a suggestion to "apt-get install mono-complete" should probably be added. And maybe about running the stuart commands with -v if an error occurs. For example over the weekend I'd installed mono-runtime but not mono-complete, and the default output gave me no idea what was going wrong. -- Rebecca Cran On 12/5/22 10:32, Michael Kubacki wrote: > I'm still trying to determine what to change for this particular series > to look correct on the mailing list. > > In the meantime, if you want to see it, it is available here on my fork: > > https://github.com/makubacki/tianocore.github.io/commits/add_stuart_build_instructions > > Thanks, > Michael > > On 12/5/2022 11:26 AM, Rebecca Cran wrote: >> 2/4 just came through. >> >> On 12/5/22 09:26, Michael Kubacki wrote: >>> Thanks, I'm working on it. >>> >>> On 12/5/2022 11:25 AM, Rebecca Cran wrote: >>>> Messages 1/4 and 4/4 are empty, and 2/4 seems to be missing. >>>> >>> >>> >>> >>> >>> >> >> >> >> >> > > > > > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#96980): https://edk2.groups.io/g/devel/message/96980 Mute This Topic: https://groups.io/mt/95472124/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=-=-=-=-=-=-=-=-=-=-=-
Thank you for the feedback. I'll add that to v2. On 12/5/2022 12:42 PM, Rebecca Cran wrote: > Thanks. I don't see any mention of needing mono on Linux - so a > suggestion to "apt-get install mono-complete" should probably be added. > > And maybe about running the stuart commands with -v if an error occurs. > For example over the weekend I'd installed mono-runtime but not > mono-complete, and the default output gave me no idea what was going wrong. > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#96983): https://edk2.groups.io/g/devel/message/96983 Mute This Topic: https://groups.io/mt/95472124/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=-=-=-=-=-=-=-=-=-=-=-
-=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#96963): https://edk2.groups.io/g/devel/message/96963 Mute This Topic: https://groups.io/mt/95472137/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=-=-=-=-=-=-=-=-=-=-=-
-=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#96966): https://edk2.groups.io/g/devel/message/96966 Mute This Topic: https://groups.io/mt/95472141/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=-=-=-=-=-=-=-=-=-=-=-
© 2016 - 2024 Red Hat, Inc.