[edk2-devel] [edk2-wiki][PATCH v3 0/4] Add new edk2 build instructions

Michael Kubacki posted 4 patches 1 year, 3 months ago
Failed in applying to current master (apply log)
Build-Instructions.md                  |  35 +
Build.mediawiki                        | 229 +++---
BuildTool-Setup-Guide.mediawiki        |  89 +--
Common-instructions-for-Unix.mediawiki | 377 +++++-----
Common-instructions.mediawiki          | 211 +++---
Getting-Started-with-EDK-II.mediawiki  |  16 +-
How-to-Build-With-Stuart.md            | 758 ++++++++++++++++++++
How-to-Develop-With-Containers.md      | 120 ++++
UDK2017-How-to-Build.md                | 252 +++----
UDK2018-How-to-Build.md                | 262 +++----
Unix-like-systems.mediawiki            | 425 +++++------
Using-EDK-II-with-Native-GCC.mediawiki | 483 ++++++-------
Windows-systems.mediawiki              | 314 ++++----
13 files changed, 2265 insertions(+), 1306 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
[edk2-devel] [edk2-wiki][PATCH v3 0/4] Add new edk2 build instructions
Posted by Michael Kubacki 1 year, 3 months ago
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.

Some patches in this series are not being sent properly. Visit the
GitHub branch to see the changes:

https://github.com/makubacki/tianocore.github.io/tree/add_stuart_build_instructions_v3

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.

V3 Changes:

- Added instructions for updating dependencies to
  "How to Build with Stuart"

V2 Changes:

- Added Linux Mono instructions to "How to Build with Stuart"
  instructions
- Added `-v` argument recommendation to the
  "How do I get more detailed information if an error happens?"
  section in "How to Build with Stuart"
- Updated HTML style to include indentation toward end of the
  file

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                        | 229 +++---
 BuildTool-Setup-Guide.mediawiki        |  89 +--
 Common-instructions-for-Unix.mediawiki | 377 +++++-----
 Common-instructions.mediawiki          | 211 +++---
 Getting-Started-with-EDK-II.mediawiki  |  16 +-
 How-to-Build-With-Stuart.md            | 758 ++++++++++++++++++++
 How-to-Develop-With-Containers.md      | 120 ++++
 UDK2017-How-to-Build.md                | 252 +++----
 UDK2018-How-to-Build.md                | 262 +++----
 Unix-like-systems.mediawiki            | 425 +++++------
 Using-EDK-II-with-Native-GCC.mediawiki | 483 ++++++-------
 Windows-systems.mediawiki              | 314 ++++----
 13 files changed, 2265 insertions(+), 1306 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 (#97093): https://edk2.groups.io/g/devel/message/97093
Mute This Topic: https://groups.io/mt/95518589/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-