From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from linux.microsoft.com (linux.microsoft.com [13.77.154.182]) by mx.groups.io with SMTP id smtpd.web10.33760.1670286067756275432 for ; Mon, 05 Dec 2022 16:21:07 -0800 Authentication-Results: mx.groups.io; dkim=fail reason="body hash did not verify" header.i=@linux.microsoft.com header.s=default header.b=Jq6jkqp5; spf=pass (domain: linux.microsoft.com, ip: 13.77.154.182, mailfrom: mikuback@linux.microsoft.com) Received: from localhost.localdomain (unknown [47.201.8.94]) by linux.microsoft.com (Postfix) with ESMTPSA id 99E4420B83CB; Mon, 5 Dec 2022 16:21:06 -0800 (PST) DKIM-Filter: OpenDKIM Filter v2.11.0 linux.microsoft.com 99E4420B83CB DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.microsoft.com; s=default; t=1670286067; bh=bJCtvygoWwpqbnvUkISOur6gDPxcS/nMdYUUW8NOqWQ=; h=From:To:Cc:Subject:Date:From; b=Jq6jkqp5cLAQaxlFbHbNOseFQZu9tUn7QVTAYkmahQ0rNYXhbzF5c8+TqxPzxlNCD i0qE4JI5aekGthWIpe9vFo23Wskrn+AzyDqx6WGabmjRkYukaC9EaJaflpUBoYZqx2 FOKphXz291Vf9aJYrEA+YXistF5IVWvdfY9YFZhQ= From: "Michael Kubacki" To: devel@edk2.groups.io Cc: Sean Brogan , Michael D Kinney , Liming Gao , Chris Fernald Subject: [edk2-wiki][PATCH v2 0/4] Add new edk2 build instructions Date: Mon, 5 Dec 2022 19:20:45 -0500 Message-Id: <20221206002049.3155-1-mikuback@linux.microsoft.com> X-Mailer: git-send-email 2.28.0.windows.1 MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable From: Michael Kubacki 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_in= structions_v2 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. 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 Cc: Michael D Kinney Cc: Liming Gao Cc: Chris Fernald Signed-off-by: Michael Kubacki 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 | 735 ++++++++++++++++++++ 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, 2242 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