[edk2] [staging/edk2-test PATCH V2 1/6] edk2-test: Update Readme.md

Michael Kinney posted 6 patches 7 years, 9 months ago
[edk2] [staging/edk2-test PATCH V2 1/6] edk2-test: Update Readme.md
Posted by Michael Kinney 7 years, 9 months ago
* Add Supreeth Venkatesh to list of branch owners
* Clean up environment variable for Windows builds
* Add Linux Build Instructions

Cc: Andrew Fish <afish@apple.com>
Cc: Supreeth Venkatesh <Supreeth.Venkatesh@arm.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Michael Kinney <michael.d.kinney@intel.com>
---
 Readme.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 48 insertions(+), 4 deletions(-)

diff --git a/Readme.md b/Readme.md
index 4ca0ffa..c5cf1ff 100644
--- a/Readme.md
+++ b/Readme.md
@@ -3,8 +3,9 @@
 edk2-staging branch for a test harness, test case SDK, and test cases for the
 edk2 repository and platform firmware that is based on the edk2 repository.
 
-## **edk2-stagaing branch owners**
+## **edk2-staging branch owners**
 * Michael Kinney <michael.d.kinney@intel.com>
+* Supreeth Venkatesh <Supreeth.Venkatesh@arm.com>
 
 ## **Features**
 * Test harness that runs from the UEFI Shell
@@ -76,13 +77,13 @@ build output directory.
 
 ```cmd
 git clone https://github.com/tianocore/edk2.git
-git clone https://github.com/tianocore/edk2-staging.git --brach edk2-test
+git clone https://github.com/tianocore/edk2-staging.git --branch edk2-test
 
 set WORKSPACE=%CD%
 set EDK_TOOLS_PATH=%WORKSPACE%\edk2\BaseTools
+set EDK_TOOLS_BIN=%EDK_TOOLS_PATH%\BinWrappers\WindowsLike
 set PACKAGES_PATH=%WORKSPACE%\edk2;%WORKSPACE%\edk2-staging
-set EDK_TOOLS_BIN=%WORKSPACE%\BaseTools\BinWrappers\WindowsLike
-path=%path%;%WORKSPACE%\edk2\BaseTools\Bin\Win32
+path=%path%;%EDK_TOOLS_PATH%\Bin\Win32
 
 cd edk2
 edkSetup.bat
@@ -93,6 +94,49 @@ build -a IA32 -a X64 -t VS2015x86 -p TestCasePkg/TestCasePkg.dsc
 
 ## **Linux Build Instructions**
 
+### Pre-requisites
+
+* GIT client: Available from https://git-scm.com/downloads
+* GCC 4.9 compiler or XCODE compiler
+
+Create a new directory for an EDK II WORKSPACE.
+
+The code block below shows the GIT clone operations required to pull the edk2
+repository, and the edk2-test branch from the edk2-staging repository.
+
+Next it sets environment variables that must be set before running
+```edksetup.bat```. Since content is being pulled from multiple repositories,
+the EDK II [Multiple Workspace](
+https://github.com/tianocore/tianocore.github.io/wiki/Multiple_Workspace)
+feature is used.
+
+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 ```TestFrameworkPkg/TestFrameworkPkg.dsc``` builds a test harness and creates
+an installer in the build output directory.  The second one in
+```TestCasePkg/TestCasePkg.dsc``` builds a sample test case using a test library
+from the ```TestFrameworkPkg``` and adds the test case to the installer in the
+build output directory.
+
+```cmd
+git clone https://github.com/tianocore/edk2.git
+git clone https://github.com/tianocore/edk2-staging.git --branch edk2-test
+
+export WORKSPACE=`pwd`
+export EDK_TOOLS_PATH="$WORKSPACE/edk2/BaseTools"
+export PACKAGES_PATH="$WORKSPACE/edk2:$WORKSPACE/edk2-staging"
+export EDK_TOOLS_BIN="$WORKSPACE/edk2/BaseTools/BinWrappers/PosixLike"
+export CONF_PATH="$WORKSPACE/edk2/Conf"
+export PATH="$PATH:$EDK_TOOLS_BIN"
+
+cd edk2
+make -C BaseTools
+. edksetup.sh
+
+build -a IA32 -a X64 -t GCC49 -p TestFrameworkPkg/TestFrameworkPkg.dsc
+build -a IA32 -a X64 -t GCC49 -p TestCasePkg/TestCasePkg.dsc
+```
+
 ## **Installation Instructions**
 
 * Copy the Build/SctPackage directory to media for the target platform
-- 
2.6.3.windows.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Re: [edk2] [staging/edk2-test PATCH V2 1/6] edk2-test: Update Readme.md
Posted by Supreeth Venkatesh 7 years, 9 months ago
This looks fine to me , albeit there is a post build error, which I think will be handled by the python script patch which you are working on as opposed to .cmd file.
- Postbuild Start -
/bin/bash: /home/supven01/edk2-test/edk2-staging/TestFrameworkPkg/GenFramework.cmd: Permission denied
build.py...
 : error F008: Postbuild process is not success!

Tested-by: Supreeth Venkatesh <supreeth.venkatesh@arm.com>
Reviewed-by: Supreeth Venkatesh <supreeth.venkatesh@arm.com>

-----Original Message-----
From: Michael Kinney [mailto:michael.d.kinney@intel.com]
Sent: Wednesday, February 01, 2017 3:49 AM
To: edk2-devel@lists.01.org
Cc: Andrew Fish; Supreeth Venkatesh
Subject: [staging/edk2-test PATCH V2 1/6] edk2-test: Update Readme.md

* Add Supreeth Venkatesh to list of branch owners
* Clean up environment variable for Windows builds
* Add Linux Build Instructions

Cc: Andrew Fish <afish@apple.com>
Cc: Supreeth Venkatesh <Supreeth.Venkatesh@arm.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Michael Kinney <michael.d.kinney@intel.com>
---
 Readme.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 48 insertions(+), 4 deletions(-)

diff --git a/Readme.md b/Readme.md
index 4ca0ffa..c5cf1ff 100644
--- a/Readme.md
+++ b/Readme.md
@@ -3,8 +3,9 @@
 edk2-staging branch for a test harness, test case SDK, and test cases for the
 edk2 repository and platform firmware that is based on the edk2 repository.

-## **edk2-stagaing branch owners**
+## **edk2-staging branch owners**
 * Michael Kinney <michael.d.kinney@intel.com>
+* Supreeth Venkatesh <Supreeth.Venkatesh@arm.com>

 ## **Features**
 * Test harness that runs from the UEFI Shell @@ -76,13 +77,13 @@ build output directory.

 ```cmd
 git clone https://github.com/tianocore/edk2.git
-git clone https://github.com/tianocore/edk2-staging.git --brach edk2-test
+git clone https://github.com/tianocore/edk2-staging.git --branch
+edk2-test

 set WORKSPACE=%CD%
 set EDK_TOOLS_PATH=%WORKSPACE%\edk2\BaseTools
+set EDK_TOOLS_BIN=%EDK_TOOLS_PATH%\BinWrappers\WindowsLike
 set PACKAGES_PATH=%WORKSPACE%\edk2;%WORKSPACE%\edk2-staging
-set EDK_TOOLS_BIN=%WORKSPACE%\BaseTools\BinWrappers\WindowsLike
-path=%path%;%WORKSPACE%\edk2\BaseTools\Bin\Win32
+path=%path%;%EDK_TOOLS_PATH%\Bin\Win32

 cd edk2
 edkSetup.bat
@@ -93,6 +94,49 @@ build -a IA32 -a X64 -t VS2015x86 -p TestCasePkg/TestCasePkg.dsc

 ## **Linux Build Instructions**

+### Pre-requisites
+
+* GIT client: Available from https://git-scm.com/downloads
+* GCC 4.9 compiler or XCODE compiler
+
+Create a new directory for an EDK II WORKSPACE.
+
+The code block below shows the GIT clone operations required to pull
+the edk2 repository, and the edk2-test branch from the edk2-staging repository.
+
+Next it sets environment variables that must be set before running
+```edksetup.bat```. Since content is being pulled from multiple
+repositories, the EDK II [Multiple Workspace](
+https://github.com/tianocore/tianocore.github.io/wiki/Multiple_Workspac
+e)
+feature is used.
+
+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 ```TestFrameworkPkg/TestFrameworkPkg.dsc``` builds a
+test harness and creates an installer in the build output directory.
+The second one in ```TestCasePkg/TestCasePkg.dsc``` builds a sample
+test case using a test library from the ```TestFrameworkPkg``` and adds
+the test case to the installer in the build output directory.
+
+```cmd
+git clone https://github.com/tianocore/edk2.git
+git clone https://github.com/tianocore/edk2-staging.git --branch
+edk2-test
+
+export WORKSPACE=`pwd`
+export EDK_TOOLS_PATH="$WORKSPACE/edk2/BaseTools"
+export PACKAGES_PATH="$WORKSPACE/edk2:$WORKSPACE/edk2-staging"
+export EDK_TOOLS_BIN="$WORKSPACE/edk2/BaseTools/BinWrappers/PosixLike"
+export CONF_PATH="$WORKSPACE/edk2/Conf"
+export PATH="$PATH:$EDK_TOOLS_BIN"
+
+cd edk2
+make -C BaseTools
+. edksetup.sh
+
+build -a IA32 -a X64 -t GCC49 -p TestFrameworkPkg/TestFrameworkPkg.dsc
+build -a IA32 -a X64 -t GCC49 -p TestCasePkg/TestCasePkg.dsc ```
+
 ## **Installation Instructions**

 * Copy the Build/SctPackage directory to media for the target platform
--
2.6.3.windows.1

IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel