From: "Rebecca Cran" <quic_rcran@quicinc.com>
To: <devel@edk2.groups.io>, <mikuback@linux.microsoft.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>,
Michael D Kinney <michael.d.kinney@intel.com>,
Liming Gao <gaoliming@byosoft.com.cn>,
Chris Fernald <chrisf671@gmail.com>
Subject: Re: [edk2-devel] [edk2-wiki][PATCH v1 0/4] Add new edk2 build instructions
Date: Mon, 5 Dec 2022 09:25:04 -0700 [thread overview]
Message-ID: <3f28d893-1dfd-f6c6-9067-a164d5b679bd@quicinc.com> (raw)
In-Reply-To: <20221205161523.2627-1-mikuback@linux.microsoft.com>
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
>
next prev parent reply other threads:[~2022-12-05 16:25 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-05 16:15 [edk2-wiki][PATCH v1 0/4] Add new edk2 build instructions Michael Kubacki
2022-12-05 16:15 ` [edk2-wiki][PATCH v1 1/4] Add initial How to Build with Stuart Document Michael Kubacki
2022-12-05 16:15 ` [edk2-wiki][PATCH v1 2/4] Add initial container usage instructions Michael Kubacki
2022-12-05 16:15 ` [edk2-wiki][PATCH v1 3/4] Add top-level build instructions file Michael Kubacki
2022-12-05 16:15 ` [edk2-wiki][PATCH v1 4/4] Update existing build instructions Michael Kubacki
2022-12-05 16:25 ` Rebecca Cran [this message]
2022-12-05 16:26 ` [edk2-devel] [edk2-wiki][PATCH v1 0/4] Add new edk2 " Michael Kubacki
2022-12-05 16:26 ` Rebecca Cran
2022-12-05 17:32 ` Michael Kubacki
2022-12-05 17:42 ` Rebecca Cran
2022-12-05 19:46 ` Michael Kubacki
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=3f28d893-1dfd-f6c6-9067-a164d5b679bd@quicinc.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox