* [ edk2-BuildSpecification PATCH] Update build report to support -Y HASH option
@ 2017-04-25 1:57 Michael Kinney
2017-04-25 1:57 ` Michael Kinney
0 siblings, 1 reply; 3+ messages in thread
From: Michael Kinney @ 2017-04-25 1:57 UTC (permalink / raw)
To: edk2-devel; +Cc: Liming Gao, Yonghong Zhu, Kevin W Shaw
https://bugzilla.tianocore.org/show_bug.cgi?id=504
GitHub branch for review:
* https://github.com/mdkinney/edk2-BuildSpecification/tree/Bugzilla_504_AddBuildReportHashFlag
GitHub word diff view of the patches in this series:
* https://github.com/mdkinney/edk2-BuildSpecification/commit/20ff478363aa89be7adcf64fd0ba08615354c42b?w=1
Cc: Liming Gao <liming.gao@intel.com>
Cc: Yonghong Zhu <yonghong.zhu@intel.com>
Cc: Kevin W Shaw <kevin.w.shaw@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Michael Kinney <michael.d.kinney@intel.com>
Michael Kinney (1):
Update build report to support -Y HASH option
13_build_reports/131_build_report_generation_options.md | 4 ++++
13_build_reports/132_sample_launch_steps_nt32_platform.md | 11 ++++++-----
13_build_reports/133_output.md | 2 +-
13_build_reports/138_module_section.md | 4 ++++
README.md | 1 +
appendix_d_buildexe_command/d4_usage.md | 7 ++++---
6 files changed, 20 insertions(+), 9 deletions(-)
--
2.6.3.windows.1
^ permalink raw reply [flat|nested] 3+ messages in thread
* [ edk2-BuildSpecification PATCH] Update build report to support -Y HASH option
2017-04-25 1:57 [ edk2-BuildSpecification PATCH] Update build report to support -Y HASH option Michael Kinney
@ 2017-04-25 1:57 ` Michael Kinney
2017-04-25 2:29 ` Zhu, Yonghong
0 siblings, 1 reply; 3+ messages in thread
From: Michael Kinney @ 2017-04-25 1:57 UTC (permalink / raw)
To: edk2-devel; +Cc: Liming Gao, Yonghong Zhu, Kevin W Shaw
https://bugzilla.tianocore.org/show_bug.cgi?id=504
Cc: Liming Gao <liming.gao@intel.com>
Cc: Yonghong Zhu <yonghong.zhu@intel.com>
Cc: Kevin W Shaw <kevin.w.shaw@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Michael Kinney <michael.d.kinney@intel.com>
---
13_build_reports/131_build_report_generation_options.md | 4 ++++
13_build_reports/132_sample_launch_steps_nt32_platform.md | 11 ++++++-----
13_build_reports/133_output.md | 2 +-
13_build_reports/138_module_section.md | 4 ++++
README.md | 1 +
appendix_d_buildexe_command/d4_usage.md | 7 ++++---
6 files changed, 20 insertions(+), 9 deletions(-)
diff --git a/13_build_reports/131_build_report_generation_options.md b/13_build_reports/131_build_report_generation_options.md
index fc32590..05d7eb2 100644
--- a/13_build_reports/131_build_report_generation_options.md
+++ b/13_build_reports/131_build_report_generation_options.md
@@ -61,6 +61,10 @@ notification invoking sequence; Also the predicted addresses of module image
loading, entry point and notification functions. Generating this report does
take a significant amount of time, more than 2x the standard build time.
+**_Module Information_**
+
+Details of the module, may include the HASH of the `.efi` file.
+
**********
**Note:** The execution order prediction report output is an html file,
separate from the rest of the reports. All remaining reports are generated in a
diff --git a/13_build_reports/132_sample_launch_steps_nt32_platform.md b/13_build_reports/132_sample_launch_steps_nt32_platform.md
index 33ca1bf..099dc07 100644
--- a/13_build_reports/132_sample_launch_steps_nt32_platform.md
+++ b/13_build_reports/132_sample_launch_steps_nt32_platform.md
@@ -42,17 +42,18 @@ command. The following steps output the build report for NT32 platform:
5. Run **build.exe -a IA32 -p Nt32Pkg\Nt32Pkg.dsc -y ReportFile.txt**
* **-y**: This option specifies the output file name for build report.
* **-Y**: This option specifies flags that control the type of build report.
- It must be from the set of **PCD**, **LIBRARY**, **DEPEX**, **BUILD_FLAGS**,
- **FLASH**, **FIXED_ADDRESS** and **EXECUTION_ORDER**. To specify more than
- one flag, repeat the option on the command line. Example of usage:
+ It must be from the set of **PCD**, **LIBRARY**, **DEPEX**, **HASH**,
+ **BUILD_FLAGS**, **FLASH**, **FIXED_ADDRESS** and **EXECUTION_ORDER**. To
+ specify more than one flag, repeat the option on the command line. Example
+ of usage:
On the command line, append the following arguments:
**-y report_filename.txt -Y PCD -Y FLASH -Y DEPEX**
The default set of flags (if **-Y** is not specified) is: **PCD**,
- **LIBRARY**, **FLASH**, **DEPEX**, **BUILD_FLAGS** and **FIXED_ADDRESS**.
-
+ **LIBRARY**, **FLASH**, **DEPEX**, **HASH**, **BUILD_FLAGS** and
+ **FIXED_ADDRESS**.
[^1] On Microsoft Windows 7, you must be an administrator to create a directory
in the root of the C: drive. It recommended that you checkout edk2 into your
diff --git a/13_build_reports/133_output.md b/13_build_reports/133_output.md
index ce64efd..73afb0c 100644
--- a/13_build_reports/133_output.md
+++ b/13_build_reports/133_output.md
@@ -101,7 +101,7 @@ Target: DEBUG
Output Path: s:\edk2\Build\NT32IA32
Build Environment: Windows-7-6.1.7601-SP1
Build Duration: 00:01:53
-Report Contents: PCD, LIBRARY, BUILD_FLAGS, DEPEX, FLASH, FIXED_ADDRESS
+Report Contents: PCD, LIBRARY, BUILD_FLAGS, DEPEX, HASH, FLASH, FIXED_ADDRESS
>==========================================================================<
Firmware Device (FD)
FD Name: NT32
diff --git a/13_build_reports/138_module_section.md b/13_build_reports/138_module_section.md
index 23e039b..d4aa365 100644
--- a/13_build_reports/138_module_section.md
+++ b/13_build_reports/138_module_section.md
@@ -51,6 +51,8 @@ file GUID, module size, module build time stamp and driver type.
The following entries are options:
+* If using defaults or the `HASH` flag is specified:
+ - SHA1 HASH: %SHA1 HASH% and *%Module .efi file name%
* UEFI Specification Version: %The UEFI specification
version:'`UEFI_SPECIFICATION_VERSION`' in INF `[Defines]` section%
* PI Specification Version: %The PI specification
@@ -75,6 +77,7 @@ Module Name: SmbiosDxe
Module INF Path: MdeModule\Universal\SmbiosDxe\SmbiosDxe.inf
File GUID: F9D88642-0737-49BC-81B5-6889CD57D9EA
Size: 0x7000 (28.00K)
+SHA1 HASH: d94c3f180f25d6b562f477bc4a16b286cb66a8b6 *SmbiosDxe.efi
Build Time Stamp: 1969-12-31 16:00:00
Driver Type: 0x7 (DRIVER)
============================================================================
@@ -91,6 +94,7 @@ Module Name: EbcDxe
Module INF Path: MdeModule\Universal\EbcDxe\EbcDxe.inf
File GUID: 13AC6DD0-73D0-11D4-B06B-00AA00BD6DE7
Size: 0x9000 (36.00K)
+SHA1 HASH: ff4c019345614afe5c88e7fc37219c30a07f4af4 *EbcDxe.efi
Time Stamp: 1969-12-31 16:00:00
Driver Type: 0x7 (DRIVER)
============================================================================
diff --git a/README.md b/README.md
index 89578d0..b6668cc 100644
--- a/README.md
+++ b/README.md
@@ -208,3 +208,4 @@ Copyright (c) 2008-2017, Intel Corporation. All rights reserved.
| | [#479](https://bugzilla.tianocore.org/show_bug.cgi?id=479) Build spec: add description for nmake long command line handling | |
| | [#485](https://bugzilla.tianocore.org/show_bug.cgi?id=485) Build spec: add support for mixed Pcd access method | |
| | [#476](https://bugzilla.tianocore.org/show_bug.cgi?id=476) Build spec: add support for HII image package | |
+| | [#504](https://bugzilla.tianocore.org/show_bug.cgi?id=504) Update build report to support -Y HASH option | |
diff --git a/appendix_d_buildexe_command/d4_usage.md b/appendix_d_buildexe_command/d4_usage.md
index c262f1a..07b9092 100644
--- a/appendix_d_buildexe_command/d4_usage.md
+++ b/appendix_d_buildexe_command/d4_usage.md
@@ -96,11 +96,12 @@ Options:
Create/overwrite the report to the specified filename.
-Y REPORTTYPE, --report-type=REPORTTYPE
Flags that control the type of build report to
- generate. Must be one of: [PCD, LIBRARY, FLASH,
- DEPEX, BUILD_FLAGS, FIXED_ADDRESS, EXECUTION_ORDER].
+ generate. Must be one of: [PCD, LIBRARY, FLASH, DEPEX,
+ HASH, BUILD_FLAGS, FIXED_ADDRESS, EXECUTION_ORDER].
To specify more than one flag, repeat this option on
the command line and the default flag set is [PCD,
- LIBRARY, FLASH, DEPEX, BUILD_FLAGS, FIXED_ADDRESS]
+ LIBRARY, FLASH, DEPEX, HASH, BUILD_FLAGS,
+ FIXED_ADDRESS]
-F FLAG, --flag=FLAG Specify the specific option to parse EDK UNI file.
Must be one of: [-c, -s]. -c is for EDK framework UNI
file, and -s is for EDK UEFI UNI file. This option can
--
2.6.3.windows.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [ edk2-BuildSpecification PATCH] Update build report to support -Y HASH option
2017-04-25 1:57 ` Michael Kinney
@ 2017-04-25 2:29 ` Zhu, Yonghong
0 siblings, 0 replies; 3+ messages in thread
From: Zhu, Yonghong @ 2017-04-25 2:29 UTC (permalink / raw)
To: Kinney, Michael D, edk2-devel@lists.01.org
Cc: Gao, Liming, Shaw, Kevin W, Zhu, Yonghong
Reviewed-by: Yonghong Zhu <yonghong.zhu@intel.com>
Best Regards,
Zhu Yonghong
-----Original Message-----
From: Kinney, Michael D
Sent: Tuesday, April 25, 2017 9:58 AM
To: edk2-devel@lists.01.org
Cc: Gao, Liming <liming.gao@intel.com>; Zhu, Yonghong <yonghong.zhu@intel.com>; Shaw, Kevin W <kevin.w.shaw@intel.com>
Subject: [ edk2-BuildSpecification PATCH] Update build report to support -Y HASH option
https://bugzilla.tianocore.org/show_bug.cgi?id=504
Cc: Liming Gao <liming.gao@intel.com>
Cc: Yonghong Zhu <yonghong.zhu@intel.com>
Cc: Kevin W Shaw <kevin.w.shaw@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Michael Kinney <michael.d.kinney@intel.com>
---
13_build_reports/131_build_report_generation_options.md | 4 ++++
13_build_reports/132_sample_launch_steps_nt32_platform.md | 11 ++++++-----
13_build_reports/133_output.md | 2 +-
13_build_reports/138_module_section.md | 4 ++++
README.md | 1 +
appendix_d_buildexe_command/d4_usage.md | 7 ++++---
6 files changed, 20 insertions(+), 9 deletions(-)
diff --git a/13_build_reports/131_build_report_generation_options.md b/13_build_reports/131_build_report_generation_options.md
index fc32590..05d7eb2 100644
--- a/13_build_reports/131_build_report_generation_options.md
+++ b/13_build_reports/131_build_report_generation_options.md
@@ -61,6 +61,10 @@ notification invoking sequence; Also the predicted addresses of module image loading, entry point and notification functions. Generating this report does take a significant amount of time, more than 2x the standard build time.
+**_Module Information_**
+
+Details of the module, may include the HASH of the `.efi` file.
+
**********
**Note:** The execution order prediction report output is an html file, separate from the rest of the reports. All remaining reports are generated in a diff --git a/13_build_reports/132_sample_launch_steps_nt32_platform.md b/13_build_reports/132_sample_launch_steps_nt32_platform.md
index 33ca1bf..099dc07 100644
--- a/13_build_reports/132_sample_launch_steps_nt32_platform.md
+++ b/13_build_reports/132_sample_launch_steps_nt32_platform.md
@@ -42,17 +42,18 @@ command. The following steps output the build report for NT32 platform:
5. Run **build.exe -a IA32 -p Nt32Pkg\Nt32Pkg.dsc -y ReportFile.txt**
* **-y**: This option specifies the output file name for build report.
* **-Y**: This option specifies flags that control the type of build report.
- It must be from the set of **PCD**, **LIBRARY**, **DEPEX**, **BUILD_FLAGS**,
- **FLASH**, **FIXED_ADDRESS** and **EXECUTION_ORDER**. To specify more than
- one flag, repeat the option on the command line. Example of usage:
+ It must be from the set of **PCD**, **LIBRARY**, **DEPEX**, **HASH**,
+ **BUILD_FLAGS**, **FLASH**, **FIXED_ADDRESS** and **EXECUTION_ORDER**. To
+ specify more than one flag, repeat the option on the command line. Example
+ of usage:
On the command line, append the following arguments:
**-y report_filename.txt -Y PCD -Y FLASH -Y DEPEX**
The default set of flags (if **-Y** is not specified) is: **PCD**,
- **LIBRARY**, **FLASH**, **DEPEX**, **BUILD_FLAGS** and **FIXED_ADDRESS**.
-
+ **LIBRARY**, **FLASH**, **DEPEX**, **HASH**, **BUILD_FLAGS** and
+ **FIXED_ADDRESS**.
[^1] On Microsoft Windows 7, you must be an administrator to create a directory in the root of the C: drive. It recommended that you checkout edk2 into your diff --git a/13_build_reports/133_output.md b/13_build_reports/133_output.md index ce64efd..73afb0c 100644
--- a/13_build_reports/133_output.md
+++ b/13_build_reports/133_output.md
@@ -101,7 +101,7 @@ Target: DEBUG
Output Path: s:\edk2\Build\NT32IA32
Build Environment: Windows-7-6.1.7601-SP1
Build Duration: 00:01:53
-Report Contents: PCD, LIBRARY, BUILD_FLAGS, DEPEX, FLASH, FIXED_ADDRESS
+Report Contents: PCD, LIBRARY, BUILD_FLAGS, DEPEX, HASH, FLASH, FIXED_ADDRESS
>==========================================================================<
Firmware Device (FD)
FD Name: NT32
diff --git a/13_build_reports/138_module_section.md b/13_build_reports/138_module_section.md
index 23e039b..d4aa365 100644
--- a/13_build_reports/138_module_section.md
+++ b/13_build_reports/138_module_section.md
@@ -51,6 +51,8 @@ file GUID, module size, module build time stamp and driver type.
The following entries are options:
+* If using defaults or the `HASH` flag is specified:
+ - SHA1 HASH: %SHA1 HASH% and *%Module .efi file name%
* UEFI Specification Version: %The UEFI specification
version:'`UEFI_SPECIFICATION_VERSION`' in INF `[Defines]` section%
* PI Specification Version: %The PI specification
@@ -75,6 +77,7 @@ Module Name: SmbiosDxe
Module INF Path: MdeModule\Universal\SmbiosDxe\SmbiosDxe.inf
File GUID: F9D88642-0737-49BC-81B5-6889CD57D9EA
Size: 0x7000 (28.00K)
+SHA1 HASH: d94c3f180f25d6b562f477bc4a16b286cb66a8b6 *SmbiosDxe.efi
Build Time Stamp: 1969-12-31 16:00:00
Driver Type: 0x7 (DRIVER)
============================================================================
@@ -91,6 +94,7 @@ Module Name: EbcDxe
Module INF Path: MdeModule\Universal\EbcDxe\EbcDxe.inf
File GUID: 13AC6DD0-73D0-11D4-B06B-00AA00BD6DE7
Size: 0x9000 (36.00K)
+SHA1 HASH: ff4c019345614afe5c88e7fc37219c30a07f4af4 *EbcDxe.efi
Time Stamp: 1969-12-31 16:00:00
Driver Type: 0x7 (DRIVER)
============================================================================
diff --git a/README.md b/README.md
index 89578d0..b6668cc 100644
--- a/README.md
+++ b/README.md
@@ -208,3 +208,4 @@ Copyright (c) 2008-2017, Intel Corporation. All rights reserved.
| | [#479](https://bugzilla.tianocore.org/show_bug.cgi?id=479) Build spec: add description for nmake long command line handling | |
| | [#485](https://bugzilla.tianocore.org/show_bug.cgi?id=485) Build spec: add support for mixed Pcd access method | |
| | [#476](https://bugzilla.tianocore.org/show_bug.cgi?id=476) Build spec: add support for HII image package | |
+| | [#504](https://bugzilla.tianocore.org/show_bug.cgi?id=504) Update build report to support -Y HASH option | |
diff --git a/appendix_d_buildexe_command/d4_usage.md b/appendix_d_buildexe_command/d4_usage.md
index c262f1a..07b9092 100644
--- a/appendix_d_buildexe_command/d4_usage.md
+++ b/appendix_d_buildexe_command/d4_usage.md
@@ -96,11 +96,12 @@ Options:
Create/overwrite the report to the specified filename.
-Y REPORTTYPE, --report-type=REPORTTYPE
Flags that control the type of build report to
- generate. Must be one of: [PCD, LIBRARY, FLASH,
- DEPEX, BUILD_FLAGS, FIXED_ADDRESS, EXECUTION_ORDER].
+ generate. Must be one of: [PCD, LIBRARY, FLASH, DEPEX,
+ HASH, BUILD_FLAGS, FIXED_ADDRESS, EXECUTION_ORDER].
To specify more than one flag, repeat this option on
the command line and the default flag set is [PCD,
- LIBRARY, FLASH, DEPEX, BUILD_FLAGS, FIXED_ADDRESS]
+ LIBRARY, FLASH, DEPEX, HASH, BUILD_FLAGS,
+ FIXED_ADDRESS]
-F FLAG, --flag=FLAG Specify the specific option to parse EDK UNI file.
Must be one of: [-c, -s]. -c is for EDK framework UNI
file, and -s is for EDK UEFI UNI file. This option can
--
2.6.3.windows.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
end of thread, other threads:[~2017-04-25 2:29 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-04-25 1:57 [ edk2-BuildSpecification PATCH] Update build report to support -Y HASH option Michael Kinney
2017-04-25 1:57 ` Michael Kinney
2017-04-25 2:29 ` Zhu, Yonghong
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox