[PATCH 1/4] Intel/Readme.md:Add instructions about Binary Cache in Readme.md

[PATCH 1/4] Intel/Readme.md:Add instructions about Binary Cache in Readme.md

[Fan, ZhijuX]

[-- Attachment #1: Type: text/plain, Size: 3054 bytes --]

BZ:https://bugzilla.tianocore.org/show_bug.cgi?id=1784
BZ:https://bugzilla.tianocore.org/show_bug.cgi?id=1785

Add detailed instructions about Binary Cache in Readme.md,
Extend options to support Binary Cache in the Kabylake
build bld.bat file, Purley build bld.bat file, build_bios.py

Cc: Liming Gao <liming.gao@intel.com>
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Steven Shi <steven.shi@intel.com>
Cc: Shifei A Lu <shifei.a.lu@intel.com>
Cc: Xiaohu Zhou <bowen.zhou@intel.com>
Cc: Isaac W Oram <isaac.w.oram@intel.com>
Cc: Chasel Chiu <chasel.chiu@intel.com>
Cc: Michael Kubacki <michael.a.kubacki@intel.com>
Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Signed-off-by: Zhiju.Fan <zhijux.fan@intel.com>
---
 Platform/Intel/Readme.md | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/Platform/Intel/Readme.md b/Platform/Intel/Readme.md
index 443fb409b3..41ae99e8e6 100644
--- a/Platform/Intel/Readme.md
+++ b/Platform/Intel/Readme.md
@@ -133,6 +133,9 @@ return back to the minimum platform caller.
   | --silent              | silent build enabled                |
   | --performance         | performance build enabled           |
   | --fsp                 | fsp build enabled                   |
+  | --hash                | Enable hash-based caching           |
+  | --binary-destination  | create cache in specified directory |
+  | --binary-source       | Consume cache from directory        |
   |                                                             |
 
 * For more information on build options
@@ -191,14 +194,18 @@ For KabylakeOpenBoardPkg
 2. Type "cd edk2-platforms\Platform\Intel\KabylakeOpenBoardPkg\KabylakeRvp3".
 3. Type "GitEdk2MinKabylake.bat" to setup GIT environment.
 4. Type "prep" and make prebuild finish for debug build, "prep r" for release build.
-5. Type "bld" to build Kaby Lake reference platform UEFI firmware image.
+5. Type "bld" to build Kaby Lake reference platform UEFI firmware image, "bld cache-produce" Generate a cache of binary
+   files in the specified directory, "bld cache-consume" Consume a cache of binary files from the specified directory,
+   BINARY_CACHE_PATH is empty, used "BinCache" as default path.

 For PurleyOpenBoardPkg
 1. Open command window, go to the workspace directory, e.g. c:\Purley.
 2. Type "cd edk2-platforms\Platform\Intel\PurleyOpenBoardPkg\BoardMtOlympus".
 3. Type "GitEdk2MinMtOlympus.bat" to setup GIT environment.
 4. Type "bld" to build Purley Mt Olympus board UEFI firmware image, "bld release" for release build, "bld clean" to
-   remove intermediate files.
+   remove intermediate files. "bld cache-produce" Generate a cache of binary files in the specified directory,
+   "bld cache-consume" Consume a cache of binary files from the specified directory, BINARY_CACHE_PATH is empty,
+   used "BinCache" as default path. 
 
 The validated version of iasl compiler that can build MinPurley is 20180629. Older version may generate ACPI build
 errors.
-- 
2.14.1.windows.1


[-- Attachment #2: winmail.dat --]
[-- Type: application/ms-tnef, Size: 4725 bytes --]

Re: [PATCH 1/4] Intel/Readme.md:Add instructions about Binary Cache in Readme.md

[Chiu, Chasel]

Reviewed-by: Chasel Chiu <chasel.chiu@intel.com>

> -----Original Message-----
> From: Fan, ZhijuX
> Sent: Friday, May 31, 2019 9:37 AM
> To: devel@edk2.groups.io
> Cc: Gao, Liming <liming.gao@intel.com>; Feng, Bob C <bob.c.feng@intel.com>;
> Shi, Steven <steven.shi@intel.com>; Lu, Shifei A <shifei.a.lu@intel.com>; Zhou,
> Bowen <bowen.zhou@intel.com>; Oram, Isaac W <isaac.w.oram@intel.com>;
> Chiu, Chasel <chasel.chiu@intel.com>; Kubacki, Michael A
> <michael.a.kubacki@intel.com>; Desimone, Nathaniel L
> <nathaniel.l.desimone@intel.com>
> Subject: [PATCH 1/4] Intel/Readme.md:Add instructions about Binary Cache in
> Readme.md
> 
> BZ:https://bugzilla.tianocore.org/show_bug.cgi?id=1784
> BZ:https://bugzilla.tianocore.org/show_bug.cgi?id=1785
> 
> Add detailed instructions about Binary Cache in Readme.md, Extend options to
> support Binary Cache in the Kabylake build bld.bat file, Purley build bld.bat file,
> build_bios.py
> 
> Cc: Liming Gao <liming.gao@intel.com>
> Cc: Bob Feng <bob.c.feng@intel.com>
> Cc: Steven Shi <steven.shi@intel.com>
> Cc: Shifei A Lu <shifei.a.lu@intel.com>
> Cc: Xiaohu Zhou <bowen.zhou@intel.com>
> Cc: Isaac W Oram <isaac.w.oram@intel.com>
> Cc: Chasel Chiu <chasel.chiu@intel.com>
> Cc: Michael Kubacki <michael.a.kubacki@intel.com>
> Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
> Signed-off-by: Zhiju.Fan <zhijux.fan@intel.com>
> ---
>  Platform/Intel/Readme.md | 11 +++++++++--
>  1 file changed, 9 insertions(+), 2 deletions(-)
> 
> diff --git a/Platform/Intel/Readme.md b/Platform/Intel/Readme.md index
> 443fb409b3..41ae99e8e6 100644
> --- a/Platform/Intel/Readme.md
> +++ b/Platform/Intel/Readme.md
> @@ -133,6 +133,9 @@ return back to the minimum platform caller.
>    | --silent              | silent build enabled                |
>    | --performance         | performance build enabled           |
>    | --fsp                 | fsp build enabled                   |
> +  | --hash                | Enable hash-based caching           |
> +  | --binary-destination  | create cache in specified directory |
> +  | --binary-source       | Consume cache from directory        |
>    |                                                             |
> 
>  * For more information on build options @@ -191,14 +194,18 @@ For
> KabylakeOpenBoardPkg  2. Type "cd
> edk2-platforms\Platform\Intel\KabylakeOpenBoardPkg\KabylakeRvp3".
>  3. Type "GitEdk2MinKabylake.bat" to setup GIT environment.
>  4. Type "prep" and make prebuild finish for debug build, "prep r" for release
> build.
> -5. Type "bld" to build Kaby Lake reference platform UEFI firmware image.
> +5. Type "bld" to build Kaby Lake reference platform UEFI firmware image, "bld
> cache-produce" Generate a cache of binary
> +   files in the specified directory, "bld cache-consume" Consume a cache of
> binary files from the specified directory,
> +   BINARY_CACHE_PATH is empty, used "BinCache" as default path.
> 
>  For PurleyOpenBoardPkg
>  1. Open command window, go to the workspace directory, e.g. c:\Purley.
>  2. Type "cd
> edk2-platforms\Platform\Intel\PurleyOpenBoardPkg\BoardMtOlympus".
>  3. Type "GitEdk2MinMtOlympus.bat" to setup GIT environment.
>  4. Type "bld" to build Purley Mt Olympus board UEFI firmware image, "bld
> release" for release build, "bld clean" to
> -   remove intermediate files.
> +   remove intermediate files. "bld cache-produce" Generate a cache of binary
> files in the specified directory,
> +   "bld cache-consume" Consume a cache of binary files from the specified
> directory, BINARY_CACHE_PATH is empty,
> +   used "BinCache" as default path.
> 
>  The validated version of iasl compiler that can build MinPurley is 20180629.
> Older version may generate ACPI build  errors.
> --
> 2.14.1.windows.1