1. Topics
  2. [PATCH v1 5/5] OvmfPkg: Add reference to new build instructions

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

Michael Kubacki
 

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

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@...>
Cc: Jiewen Yao <jiewen.yao@...>
Cc: Jordan Justen <jordan.l.justen@...>
Cc: Gerd Hoffmann <kraxel@...>
Cc: Sean Brogan <sean.brogan@...>
Cc: Michael D Kinney <michael.d.kinney@...>
Cc: Liming Gao <gaoliming@...>
Signed-off-by: Michael Kubacki <michael.kubacki@...>
---
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.
=20
## Building with Pytools for OvmfPkg
=20
+If you are unfamiliar with Pytools, it is recommended to first read thro=
ugh
+the generic set of edk2 [Build Instructions](https://github.com/tianocor=
e/tianocore.github.io/wiki/Build-Instructions).
+
1. [Optional] Create a Python Virtual Environment - generally once per w=
orkspace
=20
``` 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 r135=
20.
=20
-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/wik=
i/Build-Instructions
+
+More OVMF-specific build information can be found at:
=20
https://github.com/tianocore/tianocore.github.io/wiki/How%20to%20build%2=
0OVMF
=20
--=20
2.28.0.windows.1
Yao, Jiewen
 

Good work. Thanks.

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

-----Original Message-----
From: mikuback@... <mikuback@...>
Sent: Tuesday, December 6, 2022 1:29 AM
To: devel@edk2.groups.io
Cc: Ard Biesheuvel <ardb+tianocore@...>; Yao, Jiewen
<jiewen.yao@...>; Justen, Jordan L <jordan.l.justen@...>;
Gerd Hoffmann <kraxel@...>; Sean Brogan
<sean.brogan@...>; Kinney, Michael D
<michael.d.kinney@...>; Gao, Liming <gaoliming@...>
Subject: [PATCH v1 5/5] OvmfPkg: Add reference to new build instructions

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

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@...>
Cc: Jiewen Yao <jiewen.yao@...>
Cc: Jordan Justen <jordan.l.justen@...>
Cc: Gerd Hoffmann <kraxel@...>
Cc: Sean Brogan <sean.brogan@...>
Cc: Michael D Kinney <michael.d.kinney@...>
Cc: Liming Gao <gaoliming@...>
Signed-off-by: Michael Kubacki <michael.kubacki@...>
---
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
1 - 2 of 2