[edk2-devel] [edk2-platforms] [PATCH 5/5] Intel/Readme.md: Updated readme with linux build instructions

[Kubacki, Michael A]

The Known Limitations section needs clean up now.

This text can be removed as a general statement:
"
 * All firmware projects can build on Windows with the validated configuration below.
    * Cross-platform build support is work-in-progress.
 * KabylakeOpenBoardPkg and ClevoOpenBoardPkg can build on Ubuntu 16.04.5 LTS with gcc version 5.4.0 and nasm version 2.11.08 with the build_bios.py script
 "

These are no longer generic limitations. I suggest deleting those bullets entirely.

The goal of this series was to add GCC5 build support so each board description should be
updated to include the tool chains and version tested to give board-specific limitations. For example, 
KabylakeOpenBoardPkg should no longer say " This firmware project build has only been tested 
using the Microsoft Visual Studio 2015 compiler." It should say:

* The Windows build was tested on Windows 10 with Visual Studio 2015
* The Linux build was tested on Ubuntu 16.04.5 LTS with GCC version 5.4.0
* The build was tested with NASM version 2.11.08

Please update this information for each board.

Thanks,
Michael

> -----Original Message-----
> From: devel at edk2.groups.io [mailto:devel at edk2.groups.io] On Behalf Of
> Agyeman, Prince
> Sent: Wednesday, May 15, 2019 10:36 AM
> To: devel at edk2.groups.io
> Cc: Agyeman, Prince <prince.agyeman at intel.com>
> Subject: [edk2-devel] [edk2-platforms] [PATCH 5/5] Intel/Readme.md:
> Updated readme with linux build instructions
> 
> From: Prince Agyeman <prince.agyeman at intel.com>
> 
> Signed-off-by: Prince Agyeman <prince.agyeman at intel.com>
> ---
>  Platform/Intel/Readme.md | 31 +++++++++++++++++++------------
>  1 file changed, 19 insertions(+), 12 deletions(-)
> 
> diff --git a/Platform/Intel/Readme.md b/Platform/Intel/Readme.md index
> fbf7351..972a1b0 100644
> --- a/Platform/Intel/Readme.md
> +++ b/Platform/Intel/Readme.md
> @@ -107,9 +107,13 @@ return back to the minimum platform caller.
> 
>  **Building with the python script**
> 
> -1. Open command window, go to the workspace directory, e.g. c:\Kabylake.
> -2. Type "cd edk2-platforms\Platform\Intel -3. Type "python build_bios.py -p
> REPLACE_WITH_BOARD_NAME"
> +1. Open command window, go to the workspace directory, e.g. c:\Kabylake
> +or ~/Kabylake in the case of a linux OS 2. If using a linux OS
> +   * Type "cd edk2"
> +   * Type "source edksetup.sh"
> +   * Type "cd ../" to go back to the workspace directory 3. Type "cd
> +edk2-platforms/Platform/Intel 4. Type "python build_bios.py -p
> +REPLACE_WITH_BOARD_NAME"
> 
>  * build_bios.py arguments:
> 
> @@ -132,18 +136,19 @@ return back to the minimum platform caller.
>    |                                                             |
> 
>  * For more information on build options
> -  * ``Type "python build_bios.py -h"``
> +  * Type "python build_bios.py -h"
> 
>  * Note
> -  * ``Python 2.7.16 and Python 3.7.3 compatible``
> -  * ``These python build scripts have been tested on Windows due to``
> [cross-platform limitations](#Known-limitations)
> +  * Python 2.7.16 and Python 3.7.3 compatible
> +  * This python build script has been tested on Windows 10 and Ubuntu
> + 16.04.5 LTS
> +  * See [cross-platform limitations](#Known-limitations)
> 
>  * Configuration Files
> -  * ``The edk2-platforms\Platform\Intel\build.cfg file contains the default
> settings used by build_bios.py``
> -  * ``The default settings are under the DEFAULT_CONFIG section``
> -  * ``Each board can have a settings file that will override the edk2-
> platforms\Platform\Intel\build.cfg settings``
> -  * ``An example of a board specific settings:``
> -    * ``edk2-
> platforms\Platform\Intel\KabylakeOpenBoardPkg\KabylakeRvp3\build_confi
> g.cfg``
> +  * The edk2-platforms\Platform\Intel\build.cfg file contains the
> + default settings used by build_bios.py
> +  * The default settings are under the DEFAULT_CONFIG section
> +  * Each board can have a settings file that will override the
> + edk2-platforms\Platform\Intel\build.cfg settings
> +  * An example of a board specific settings:
> +    *
> + edk2-
> platforms\Platform\Intel\KabylakeOpenBoardPkg\KabylakeRvp3\build_
> + config.cfg
> 
>  * Workspace view of the build scripts
>    * <pre>
> @@ -212,8 +217,10 @@ Users can also flash the UEFI firmware image to
> the highest area of the flash re
> 
>  ### **Known limitations**
> 
> -* All firmware projects can only build on Windows with the validated
> configuration below.
> +* All firmware projects can build on Windows with the validated
> configuration below.
>    * Cross-platform build support is work-in-progress.
> +* KabylakeOpenBoardPkg and ClevoOpenBoardPkg can build on Ubuntu
> +16.04.5 LTS with gcc version 5.4.0 and nasm version 2.11.08 with the
> +build_bios.py script
> 
>  **KabylakeOpenBoardPkg**
>  1. This firmware project has only been tested on the Intel KabylakeRvp3
> board.
> --
> 2.7.4
> 
> 
> 


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#40974): https://edk2.groups.io/g/devel/message/40974
Mute This Topic: https://groups.io/mt/31632307/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-