Re: [edk2] [Patch 2/2] QuarkPlatformPkg/Readme.md: edk2-non-osi directory layout

[Steele, Kelly]

Reviewed by: Kelly Steele 

-Original Message-
From: Kinney, Michael D 
Sent: August 09, 2017 12:40
To: edk2-devel@lists.01.org
Cc: Leif Lindholm ; Steele, Kelly 

Subject: [Patch 2/2] QuarkPlatformPkg/Readme.md: edk2-non-osi directory layout

The following commit moved the QuarkSocBinPkg from the root directory to the 
the Silicon/Intel directory.

https://github.com/tianocore/edk2-non-osi/commit/182e85d04566800fe188de4b1c30a50533dd74b7

The following updates are made to Readme.md:

* PACKAGES_PATH setting for edk2-non-osi directory changes
* Remove use of edk2-FatPkg repository
* Remove use of edk2-BaseTools-win32 repository
* Run python build tools from sources

Cc: Leif Lindholm 
Cc: Kelly Steele 
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Michael D Kinney 
---
 QuarkPlatformPkg/Readme.md | 34 ++
 1 file changed, 18 insertions(+), 16 deletions(-)

diff --git a/QuarkPlatformPkg/Readme.md b/QuarkPlatformPkg/Readme.md index 
f925f9ef27..aa9d9856bd 100644
--- a/QuarkPlatformPkg/Readme.md
+++ b/QuarkPlatformPkg/Readme.md
@@ -46,12 +46,12 @@
   - Install
 * ASL compiler: Available from http://www.acpica.org
   - Install into ```C:\ASL``` to match default tools_def.txt configuration.
+* Python 2.7: Available from http://www.python.org
 
 Create a new directory for an EDK II WORKSPACE.
 
 The code block below shows the GIT clone operations required to pull the EDK 
II -source tree, the FatPkg sources, the pre-built versions of BaseTools as 
WIN32 -binaries, and the edk2-non-osi repository that provides a binary file 
for the
+source tree and the edk2-non-osi repository that provides a binary file 
+for the
 Quark Remote Management Unit (RMU).
 
 Next it sets environment variables that must be set before running @@ -60,6 
+60,8 @@ the EDK II [Multiple Workspace](
 https://github.com/tianocore/tianocore.github.io/wiki/Multiple_Workspace)
 feature is used.
 
+Next, the EDK II BaseTools required to build firmware images are built.
+
 Next, the ```edksetup.bat``` file is run to complete the initialization of an  
EDK II build environment.  Two example build commands are shown.  The first one 
 in ```QuarkPlatformPlg/Quark.dsc``` builds a full UEFI firmware image that is 
@@ -69,16 +71,17 @@ image that is useful for initial power-on and debug of new 
features.
 
 ```cmd
 git clone https://github.com/tianocore/edk2.git
-git clone https://github.com/tianocore/edk2-FatPkg.git FatPkg -git clone 
https://github.com/tianocore/edk2-BaseTools-win32.git
 git clone https://github.com/tianocore/edk2-non-osi.git
 
+set PYTHON_HOME=c:\Python27
 set WORKSPACE=%CD%
-set PACKAGES_PATH=%WORKSPACE%\edk2;%WORKSPACE%\edk2-non-osi
-set EDK_TOOLS_BIN=%WORKSPACE%\edk2-BaseTools-win32
+set 
+PACKAGES_PATH=%WORKSPACE%\edk2;%WORKSPACE%\edk2-non-osi\Silicon\Intel
+set EDK_TOOLS_PATH=%WORKSPACE%\edk2\BaseTools
+cd %WORKSPACE%\edk2
 
-cd edk2
-edksetup.bat
+BaseTools\toolsetup.bat Rebuild
+
+edksetup.bat Rebuild
 
 build -a IA32 -t VS2015x86 -p QuarkPlatformPkg/Quark.dsc  build -a IA32 -t 
VS2015x86 -p QuarkPlatformPkg/QuarkMin.dsc @@ -91,12 +94,13 @@ build -a IA32 -t 
VS2015x86 -p QuarkPlatformPkg/QuarkMin.dsc
 * GIT client
 * GCC 4.9 compiler
 * ASL compiler: Available from http://www.acpica.org.
+* Python 2.7
 
 Create a new directory for an EDK II WORKSPACE.
 
 The code block below shows the GIT clone operations required to pull the EDK 
II -source tree, the FatPkg sources, and the edk2-non-osi repository that 
provides a -binary file for the Quark Remote Management Unit (RMU).
+source tree and the edk2-non-osi repository that provides a binary file 
+for the Quark Remote Management Unit (RMU).
 
 Next it sets environment variables that must be set before running  
```edksetup.bat```. Since content is being pulled from multiple repositories, 
@@ -106,7 +110,7 @@ feature is used.
 
 Next, the EDK II BaseTools required to build firmware images are built.
 
-Next, the ```edksetup.bat``` file is run to complete the initialization of an
+Next, the ```edksetup.sh``` file is run to complete the initialization 
+of an
 EDK II build environment.  Two example build commands are shown.  The first 
one  in ```QuarkPlatformPlg/Quark.dsc``` builds a full UEFI firmware image that 
is  able to boot the built-in UEFI Shell and Linux from a micro SD FLASH card.  
The @@ -115,17 +119,15 @@ image that is useful for initial power-on and debug 
of new features.
 
 ```sh
 git clone https://github.com/tianocore/edk2.git
-git clone https://github.com/tianocore/edk2-FatPkg.git FatPkg  git clone 
https://github.com/tianocore/edk2-non-osi.git
 
 export WORKSPACE=$PWD
-export PACKAGES_PATH=$WORKSPACE/edk2:$WORKSPACE/edk2-non-osi
+export 
+PACKAGES_PATH=$WORKSPACE/edk2:$WORKSPACE/edk2-non-osi/Silicon/Intel
 export 

Re: [edk2] [Patch 2/2] QuarkPlatformPkg/Readme.md: edk2-non-osi directory layout

[Leif Lindholm]

On Wed, Aug 09, 2017 at 12:39:57PM -0700, Michael D Kinney wrote:
> The following commit moved the QuarkSocBinPkg from the root
> directory to the the Silicon/Intel directory.
> 
> https://github.com/tianocore/edk2-non-osi/commit/182e85d04566800fe188de4b1c30a50533dd74b7
> 
> The following updates are made to Readme.md:
> 
> * PACKAGES_PATH setting for edk2-non-osi directory changes
> * Remove use of edk2-FatPkg repository
> * Remove use of edk2-BaseTools-win32 repository
> * Run python build tools from sources

I don't think you need my r-b on this, but I appreciate the cc.

If I was nitpicking, I would point out there are three logically
unrelated changes going on here. However, since it all consist of
updates to a single documentation file, the only change I would
request would be to the subject line to say something a bit broader
like "bring Readme.md up to date".

With that:
Reviewed-by: Leif Lindholm 

> Cc: Leif Lindholm 
> Cc: Kelly Steele 
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Michael D Kinney 
> ---
>  QuarkPlatformPkg/Readme.md | 34 ++
>  1 file changed, 18 insertions(+), 16 deletions(-)
> 
> diff --git a/QuarkPlatformPkg/Readme.md b/QuarkPlatformPkg/Readme.md
> index f925f9ef27..aa9d9856bd 100644
> --- a/QuarkPlatformPkg/Readme.md
> +++ b/QuarkPlatformPkg/Readme.md
> @@ -46,12 +46,12 @@
>- Install
>  * ASL compiler: Available from http://www.acpica.org
>- Install into ```C:\ASL``` to match default tools_def.txt configuration.
> +* Python 2.7: Available from http://www.python.org
>  
>  Create a new directory for an EDK II WORKSPACE.
>  
>  The code block below shows the GIT clone operations required to pull the EDK 
> II
> -source tree, the FatPkg sources, the pre-built versions of BaseTools as WIN32
> -binaries, and the edk2-non-osi repository that provides a binary file for the
> +source tree and the edk2-non-osi repository that provides a binary file for 
> the
>  Quark Remote Management Unit (RMU).
>  
>  Next it sets environment variables that must be set before running
> @@ -60,6 +60,8 @@ the EDK II [Multiple Workspace](
>  https://github.com/tianocore/tianocore.github.io/wiki/Multiple_Workspace)
>  feature is used.
>  
> +Next, the EDK II BaseTools required to build firmware images are built.
> +
>  Next, the ```edksetup.bat``` file is run to complete the initialization of an
>  EDK II build environment.  Two example build commands are shown.  The first 
> one
>  in ```QuarkPlatformPlg/Quark.dsc``` builds a full UEFI firmware image that is
> @@ -69,16 +71,17 @@ image that is useful for initial power-on and debug of 
> new features.
>  
>  ```cmd
>  git clone https://github.com/tianocore/edk2.git
> -git clone https://github.com/tianocore/edk2-FatPkg.git FatPkg
> -git clone https://github.com/tianocore/edk2-BaseTools-win32.git
>  git clone https://github.com/tianocore/edk2-non-osi.git
>  
> +set PYTHON_HOME=c:\Python27
>  set WORKSPACE=%CD%
> -set PACKAGES_PATH=%WORKSPACE%\edk2;%WORKSPACE%\edk2-non-osi
> -set EDK_TOOLS_BIN=%WORKSPACE%\edk2-BaseTools-win32
> +set PACKAGES_PATH=%WORKSPACE%\edk2;%WORKSPACE%\edk2-non-osi\Silicon\Intel
> +set EDK_TOOLS_PATH=%WORKSPACE%\edk2\BaseTools
> +cd %WORKSPACE%\edk2
>  
> -cd edk2
> -edksetup.bat
> +BaseTools\toolsetup.bat Rebuild
> +
> +edksetup.bat Rebuild
>  
>  build -a IA32 -t VS2015x86 -p QuarkPlatformPkg/Quark.dsc
>  build -a IA32 -t VS2015x86 -p QuarkPlatformPkg/QuarkMin.dsc
> @@ -91,12 +94,13 @@ build -a IA32 -t VS2015x86 -p 
> QuarkPlatformPkg/QuarkMin.dsc
>  * GIT client
>  * GCC 4.9 compiler
>  * ASL compiler: Available from http://www.acpica.org.
> +* Python 2.7
>  
>  Create a new directory for an EDK II WORKSPACE.
>  
>  The code block below shows the GIT clone operations required to pull the EDK 
> II
> -source tree, the FatPkg sources, and the edk2-non-osi repository that 
> provides a
> -binary file for the Quark Remote Management Unit (RMU).
> +source tree and the edk2-non-osi repository that provides a binary file for 
> the
> +Quark Remote Management Unit (RMU).
>  
>  Next it sets environment variables that must be set before running
>  ```edksetup.bat```. Since content is being pulled from multiple repositories,
> @@ -106,7 +110,7 @@ feature is used.
>  
>  Next, the EDK II BaseTools required to build firmware images are built.
>  
> -Next, the ```edksetup.bat``` file is run to complete the initialization of an
> +Next, the ```edksetup.sh``` file is run to complete the initialization of an
>  EDK II build environment.  Two example build commands are shown.  The first 
> one
>  in ```QuarkPlatformPlg/Quark.dsc``` builds a full UEFI firmware image that is
>  able to boot the built-in UEFI Shell and Linux from a micro SD FLASH card.  
> The
> @@ -115,17 +119,15 @@ image that is useful for initial power-on and debug of 
> new features.
>  
>  ```sh
>  git