[PATCH v1 0/5] Update references to new edk2 build instructions

[PATCH v1 0/5] Update references to new edk2 build instructions

[Michael Kubacki]

From: Michael Kubacki <michael.kubacki@microsoft.com>

Note: This series is dependent on the following TianoCore wiki
series being merged for links to resolve properly.

https://edk2.groups.io/g/devel/message/96962

New build instructions are being added to the TianoCore wiki [1]
to describe how to use relatively recent additions to the edk2 build
process - containers and Stuart.

This series updates build instructions in the edk2 repo with a link
to the new instructions page on the wiki so users are aware of the
instructions.

Content is only directly modified in the edk2 repo that is directly
replaced with corresponding content in the wiki page.

[1]: https://github.com/tianocore/tianocore.github.io/wiki

Cc: Andrew Fish <afish@apple.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Chris Fernald <chrisf671@gmail.com>
Cc: Gerd Hoffmann <kraxel@redhat.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Yuwei Chen <yuwei.chen@intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>

Michael Kubacki (5):
  .pytool/Readme.md: Add reference to new build instructions
  ArmVirtPkg: Add reference to new build instructions
  BaseTools: Add reference to new build instructions
  EmulatorPkg: Add reference to new build instructions
  OvmfPkg: Add reference to new build instructions

 .pytool/Readme.md                | 52 +++++++-------------
 ArmVirtPkg/PlatformCI/ReadMe.md  |  3 ++
 BaseTools/ReadMe.rst             | 13 +++--
 EmulatorPkg/PlatformCI/ReadMe.md |  3 ++
 OvmfPkg/PlatformCI/ReadMe.md     |  3 ++
 OvmfPkg/README                   |  5 +-
 6 files changed, 40 insertions(+), 39 deletions(-)

-- 
2.28.0.windows.1

[PATCH v1 1/5] .pytool/Readme.md: Add reference to new build instructions

[Michael Kubacki]

From: Michael Kubacki <michael.kubacki@microsoft.com>

Adds a reference to the new build instructions on the TianoCore wiki
that currently describe building with containers and Stuart.

Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
 .pytool/Readme.md | 52 +++++++-------------
 1 file changed, 17 insertions(+), 35 deletions(-)

diff --git a/.pytool/Readme.md b/.pytool/Readme.md
index 9c7b7f9abbec..b2688d168753 100644
--- a/.pytool/Readme.md
+++ b/.pytool/Readme.md
@@ -1,5 +1,12 @@
 # Edk2 Continuous Integration
 
+This file focuses on information for those working with the `.pytools` directory
+directly or interested in lower-level details about how CI works.
+
+If you just want to get started building code, visit
+[Build Instructions](https://github.com/tianocore/tianocore.github.io/wiki/Build-Instruction)
+on the TianoCore wiki.
+
 ## Basic Status
 
 | Package              | Windows VS2019 (IA32/X64)| Ubuntu GCC (IA32/X64/ARM/AARCH64) | Known Issues |
@@ -82,43 +89,18 @@ easily and consistently running locally and in a cloud ci environment.  To do
 that a few steps should be followed.  Details of EDKII Tools can be found in the
 [docs folder here](https://github.com/tianocore/edk2-pytool-extensions/tree/master/docs)
 
-### Prerequisites
-
-1. A supported toolchain (others might work but this is what is tested and validated)
-   * Windows 10:
-     * VS 2017 or VS 2019
-     * Windows SDK (for rc)
-     * Windows WDK (for capsules)
-   * Ubuntu 18.04 or Fedora
-     * GCC5
-   * Easy to add more but this is the current state
-2. Python 3.7.x or newer on path
-3. git on path
-4. Recommended to setup and activate a python virtual environment
-5. Install the requirements `pip install --upgrade -r pip-requirements.txt`
-
 ### Running CI
 
-1. clone your edk2 repo
-2. Activate your python virtual environment in cmd window
-3. Get code dependencies (done only when submodules change)
-   * `stuart_setup -c .pytool/CISettings.py TOOL_CHAIN_TAG=<your tag here>`
-4. Update other dependencies (done more often)
-   * `stuart_update -c .pytool/CISettings.py TOOL_CHAIN_TAG=<your tag here>`
-5. Run CI build (--help will give you options)
-   * `stuart_ci_build -c .pytool/CISettings.py TOOL_CHAIN_TAG=<your tag here>`
-   * -p <pkg1,pkg2,pkg3> : To build only certain packages use a CSV list
-   * -a <arch1,arch2,arch3>: To run only certain architectures use a CSV list
-   * -t <target1,target2>: To run only tests related to certain targets use a
-     CSV list
-   * By default all tests are opted in.  Then given a package.ci.yaml file those
-     tests can be configured for a package. Finally setting the check to the
-     value `skip` will skip that plugin.  Examples:
-     * `CompilerPlugin=skip` skip the build test
-     * `GuidCheck=skip` skip the Guid check
-     * `SpellCheck=skip` skip the spell checker
-     * etc
-6. Detailed reports and logs per package are captured in the `Build` directory
+Quick notes:
+
+* By default all CI plugins are opted in.
+  * Setting the plugin to `skip` as an argument will skip running the plugin.
+    Examples:
+    * `CompilerPlugin=skip` skip the build test
+    * `GuidCheck=skip` skip the Guid check
+    * `SpellCheck=skip` skip the spell checker
+    * etc.
+* Detailed reports and logs per package are captured in the `Build` directory.
 
 ## Current PyTool Test Capabilities
 
-- 
2.28.0.windows.1

[PATCH v1 2/5] ArmVirtPkg: Add reference to new build instructions

[Michael Kubacki]

From: Michael Kubacki <michael.kubacki@microsoft.com>

Adds a reference to the new build instructions on the TianoCore wiki
that currently describe building with containers and Stuart.

Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Cc: Gerd Hoffmann <kraxel@redhat.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
 ArmVirtPkg/PlatformCI/ReadMe.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/ArmVirtPkg/PlatformCI/ReadMe.md b/ArmVirtPkg/PlatformCI/ReadMe.md
index 7c11d925f59e..ee8d8cd61e73 100644
--- a/ArmVirtPkg/PlatformCI/ReadMe.md
+++ b/ArmVirtPkg/PlatformCI/ReadMe.md
@@ -29,6 +29,9 @@ Pytools build system.
 
 ## Building with Pytools for ArmVirtPkg
 
+If you are unfamiliar with Pytools, it is recommended to first read through
+the generic set of edk2 [Build Instructions](https://github.com/tianocore/tianocore.github.io/wiki/Build-Instructions).
+
 1. [Optional] Create a Python Virtual Environment - generally once per workspace
 
     ``` bash
-- 
2.28.0.windows.1

[PATCH v1 3/5] BaseTools: Add reference to new build instructions

[Michael Kubacki]

From: Michael Kubacki <michael.kubacki@microsoft.com>

Adds a reference to the new build instructions on the TianoCore wiki
that currently describe building with containers and Stuart.

Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Yuwei Chen <yuwei.chen@intel.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
 BaseTools/ReadMe.rst | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/BaseTools/ReadMe.rst b/BaseTools/ReadMe.rst
index de85ca4be65e..592be51b1fcd 100644
--- a/BaseTools/ReadMe.rst
+++ b/BaseTools/ReadMe.rst
@@ -1,3 +1,13 @@
+::
+
+  Note: New build instructions are available. It is recommended to start with
+  the new instructions if learning how to build edk2 and/or BaseTools for the
+  first time. This page is retained for reference.
+
+New instructions: `Build Instructions`_
+
+.. _`Build Instructions`: https://github.com/tianocore/tianocore.github.io/wiki/Build-Instructions
+
 This directory contains the EDK II build tools and template files.
 Templates are located in the Conf directory, while the tools executables for
 Microsoft Windows Operating Systems are located in the Bin\\Win32 directory, other
@@ -23,9 +33,6 @@ After this, you can run the toolsetup.bat file, which is in the same
 directory as this file.  It should setup the remainder of the environment,
 and build the tools if necessary.
 
-Please also refer to the ``BuildNotes.txt`` file for more information on
-building under Windows.
-
 Unix-like operating systems
 ===========================
 
-- 
2.28.0.windows.1

[PATCH v1 4/5] EmulatorPkg: Add reference to new build instructions

[Michael Kubacki]

From: Michael Kubacki <michael.kubacki@microsoft.com>

Adds a reference to the new build instructions on the TianoCore wiki
that currently describe building with containers and Stuart.

Cc: Andrew Fish <afish@apple.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
 EmulatorPkg/PlatformCI/ReadMe.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/EmulatorPkg/PlatformCI/ReadMe.md b/EmulatorPkg/PlatformCI/ReadMe.md
index 91c40b2093b1..f123bb2a4892 100644
--- a/EmulatorPkg/PlatformCI/ReadMe.md
+++ b/EmulatorPkg/PlatformCI/ReadMe.md
@@ -42,6 +42,9 @@ Pytools build system.
 
 ## Building with Pytools for EmulatorPkg
 
+If you are unfamiliar with Pytools, it is recommended to first read through
+the generic set of edk2 [Build Instructions](https://github.com/tianocore/tianocore.github.io/wiki/Build-Instructions).
+
 1. [Optional] Create a Python Virtual Environment - generally once per workspace
 
     ``` bash
-- 
2.28.0.windows.1

[PATCH v1 5/5] OvmfPkg: Add reference to new build instructions

[Michael Kubacki]

From: Michael Kubacki <michael.kubacki@microsoft.com>

Adds a reference to the new build instructions on the TianoCore wiki
that currently describe building with containers and Stuart.

Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Gerd Hoffmann <kraxel@redhat.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
 OvmfPkg/PlatformCI/ReadMe.md | 3 +++
 OvmfPkg/README               | 5 ++++-
 2 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/OvmfPkg/PlatformCI/ReadMe.md b/OvmfPkg/PlatformCI/ReadMe.md
index 1216dee126f1..10fa32ac489f 100644
--- a/OvmfPkg/PlatformCI/ReadMe.md
+++ b/OvmfPkg/PlatformCI/ReadMe.md
@@ -31,6 +31,9 @@ Pytools build system.
 
 ## Building with Pytools for OvmfPkg
 
+If you are unfamiliar with Pytools, it is recommended to first read through
+the generic set of edk2 [Build Instructions](https://github.com/tianocore/tianocore.github.io/wiki/Build-Instructions).
+
 1. [Optional] Create a Python Virtual Environment - generally once per workspace
 
     ``` bash
diff --git a/OvmfPkg/README b/OvmfPkg/README
index d6e7e328483b..0a408abf019d 100644
--- a/OvmfPkg/README
+++ b/OvmfPkg/README
@@ -53,7 +53,10 @@ these binary outputs:
 * OvmfVideo.rom
   - This file is not built separately any longer, starting with svn r13520.
 
-More information on building OVMF can be found at:
+If you are new to building in edk2 or looking for the latest build
+instructions, visit https://github.com/tianocore/tianocore.github.io/wiki/Build-Instructions
+
+More OVMF-specific build information can be found at:
 
 https://github.com/tianocore/tianocore.github.io/wiki/How%20to%20build%20OVMF
 
-- 
2.28.0.windows.1

Re: [PATCH v1 5/5] OvmfPkg: Add reference to new build instructions

[Yao, Jiewen]

Good work. Thanks.

Reviewed-by: Jiewen Yao <Jiewen.yao@intel.com>

> -----Original Message-----
> From: mikuback@linux.microsoft.com <mikuback@linux.microsoft.com>
> Sent: Tuesday, December 6, 2022 1:29 AM
> To: devel@edk2.groups.io
> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>; Yao, Jiewen
> <jiewen.yao@intel.com>; Justen, Jordan L <jordan.l.justen@intel.com>;
> Gerd Hoffmann <kraxel@redhat.com>; Sean Brogan
> <sean.brogan@microsoft.com>; Kinney, Michael D
> <michael.d.kinney@intel.com>; Gao, Liming <gaoliming@byosoft.com.cn>
> Subject: [PATCH v1 5/5] OvmfPkg: Add reference to new build instructions
> 
> From: Michael Kubacki <michael.kubacki@microsoft.com>
> 
> Adds a reference to the new build instructions on the TianoCore wiki
> that currently describe building with containers and Stuart.
> 
> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> Cc: Jiewen Yao <jiewen.yao@intel.com>
> Cc: Jordan Justen <jordan.l.justen@intel.com>
> Cc: Gerd Hoffmann <kraxel@redhat.com>
> Cc: Sean Brogan <sean.brogan@microsoft.com>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> ---
>  OvmfPkg/PlatformCI/ReadMe.md | 3 +++
>  OvmfPkg/README               | 5 ++++-
>  2 files changed, 7 insertions(+), 1 deletion(-)
> 
> diff --git a/OvmfPkg/PlatformCI/ReadMe.md
> b/OvmfPkg/PlatformCI/ReadMe.md
> index 1216dee126f1..10fa32ac489f 100644
> --- a/OvmfPkg/PlatformCI/ReadMe.md
> +++ b/OvmfPkg/PlatformCI/ReadMe.md
> @@ -31,6 +31,9 @@ Pytools build system.
> 
>  ## Building with Pytools for OvmfPkg
> 
> +If you are unfamiliar with Pytools, it is recommended to first read through
> +the generic set of edk2 [Build
> Instructions](https://github.com/tianocore/tianocore.github.io/wiki/Build-
> Instructions).
> +
>  1. [Optional] Create a Python Virtual Environment - generally once per
> workspace
> 
>      ``` bash
> diff --git a/OvmfPkg/README b/OvmfPkg/README
> index d6e7e328483b..0a408abf019d 100644
> --- a/OvmfPkg/README
> +++ b/OvmfPkg/README
> @@ -53,7 +53,10 @@ these binary outputs:
>  * OvmfVideo.rom
>    - This file is not built separately any longer, starting with svn r13520.
> 
> -More information on building OVMF can be found at:
> +If you are new to building in edk2 or looking for the latest build
> +instructions, visit
> https://github.com/tianocore/tianocore.github.io/wiki/Build-Instructions
> +
> +More OVMF-specific build information can be found at:
> 
> 
> https://github.com/tianocore/tianocore.github.io/wiki/How%20to%20buil
> d%20OVMF
> 
> --
> 2.28.0.windows.1