V2hlbiBtYWtlIG9yIG5tYWtlIGZhaWxzIHRvIGJ1aWxkIHRoZSBiYXNldG9vbHMsIEVkazJUb29sc0J1aWxkLnB5CmN1cnJlbnRseSBwcmludHMgYSBnZW5lcmljIGVycm9yIG1lc3NhZ2UgIkZhaWxlZCB0byBidWlsZC4iIGFuZApyYWlzZXMgYW4gZXhjZXB0aW9uLiBUaGlzIGhhcyB0d28gaXNzdWVzOiBUaGUgZmlyc3QgaXMgdGhhdCBpdCByYWlzZXMKYW4gZXhjZXB0aW9uLCB3aGljaCBsZWFkcyBwZW9wbGUgdG8gYmVsaWV2ZSBpdCBpcyBhIHB5dGhvbiBpc3N1ZSwgYW5kCm5vdCBhIGJ1aWxkIGlzc3VlLiBUaGUgc2Vjb25kIGlzIHRoYXQgdXNlcnMgZG9uJ3QgbmVjZXNzYXJpbHkga25vdyB0bwpjaGVjayB0aGUgYnVpbGQgbG9nIGlmIHRoaXMgZXJyb3Igb2NjdXJzLgoKVGhpcyBoYXMgYmVlbiByZXBvcnRlZCBtYW55IHRpbWVzIHRocm91Z2ggbWFueSBkaWZmZXJlbnQgYXZlbnVlczoKCmh0dHBzOi8vZ2l0aHViLmNvbS90aWFub2NvcmUvZWRrMi9kaXNjdXNzaW9ucy80NjExCmh0dHBzOi8vc3RhY2tvdmVyZmxvdy5jb20vcXVlc3Rpb25zLzc3NDIxMTY4L2Vka2lpLWJhc2UtdG9vbHMtZmFpbHMtdG8tYnVpbGQKaHR0cHM6Ly9naXRodWIuY29tL3RpYW5vY29yZS9lZGsyLXB5dG9vbC1leHRlbnNpb25zL2lzc3Vlcy8xODAKaHR0cHM6Ly9naXRodWIuY29tL3RpYW5vY29yZS9lZGsyLXB5dG9vbC1leHRlbnNpb25zL2lzc3Vlcy8yMDcKClRoaXMgcGF0Y2ggc2VyaWVzIGNoYW5nZXMgdGhlIGV4Y2VwdGlvbiB0byBhIGVycm9yIGxvZyBzbyB0aGF0IHRoZSBpbnZvY2FibGUKY29tcGxldGVzIGFuZCByZXR1cm5zIGEgbm9uLXplcm8gZXhpdCBjb2RlIGFuZCBhbHNvIGxvZ3MgYSBtb3JlIGRlc2NyaXB0aXZlCmVycm9yIHRoYXQgaW5mb3JtcyB0aGUgdXNlciB0byByZXZpZXcgdGhlIGJ1aWxkIGxvZywgYW5kIHdoZXJlIHRvIGZpbmQgaXQuCgpDYzogUmViZWNjYSBDcmFuIDxyZWJlY2NhQGJzZGlvLmNvbT4KQ2M6IExpbWluZyBHYW8gPGdhb2xpbWluZ0BieW9zb2Z0LmNvbS5jbj4KQ2M6IEJvYiBGZW5nIDxib2IuYy5mZW5nQGludGVsLmNvbT4KQ2M6IFl1d2VpIENoZW4gPHl1d2VpLmNoZW5AaW50ZWwuY29tPgoKSm9leSBWYWdlZGVzICgxKToKICBCYXNlVG9vbHM6IEVkazJUb29sc0J1aWxkLnB5OiBDbGFyaWZ5IG1ha2UgZXJyb3IKCiBCYXNlVG9vbHMvRWRrMlRvb2xzQnVpbGQucHkgfCA4ICsrKysrKy0tCiAxIGZpbGUgY2hhbmdlZCwgNiBpbnNlcnRpb25zKCspLCAyIGRlbGV0aW9ucygtKQoKLS0gCjIuMzQuMQoK-=-=-=-=-=-=-=-=-=-=-=-Groups.io Links: You receive all messages sent to this group.View/Reply Online (#110756): https://edk2.groups.io/g/devel/message/110756Mute This Topic: https://groups.io/mt/102428861/1787277Group Owner: devel+owner@edk2.groups.ioUnsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]-=-=-=-=-=-=-=-=-=-=-=-

Series Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>


> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Joey
> Vagedes via groups.io
> Sent: Monday, November 6, 2023 12:12 PM
> To: devel@edk2.groups.io
> Cc: Rebecca Cran <rebecca@bsdio.com>; Gao, Liming
> <gaoliming@byosoft.com.cn>; Feng, Bob C <bob.c.feng@intel.com>; Chen,
> Christine <yuwei.chen@intel.com>
> Subject: [edk2-devel] [PATCH v2 0/1] Edk2ToolsBuild.py: Clarify make
> error
> 
> When make or nmake fails to build the basetools, Edk2ToolsBuild.py
> currently prints a generic error message "Failed to build." and
> raises an exception. This has two issues: The first is that it raises
> an exception, which leads people to believe it is a python issue, and
> not a build issue. The second is that users don't necessarily know to
> check the build log if this error occurs.
> 
> This has been reported many times through many different avenues:
> 
> https://github.com/tianocore/edk2/discussions/4611
> https://stackoverflow.com/questions/77421168/edkii-base-tools-fails-
> to-build
> https://github.com/tianocore/edk2-pytool-extensions/issues/180
> https://github.com/tianocore/edk2-pytool-extensions/issues/207
> 
> This patch series changes the exception to a error log so that the
> invocable
> completes and returns a non-zero exit code and also logs a more
> descriptive
> error that informs the user to review the build log, and where to find
> it.
> 
> Cc: Rebecca Cran <rebecca@bsdio.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Bob Feng <bob.c.feng@intel.com>
> Cc: Yuwei Chen <yuwei.chen@intel.com>
> 
> Joey Vagedes (1):
>   BaseTools: Edk2ToolsBuild.py: Clarify make error
> 
>  BaseTools/Edk2ToolsBuild.py | 8 ++++++--
>  1 file changed, 6 insertions(+), 2 deletions(-)
> 
> --
> 2.34.1
> 
> º.¦È¨.)䱊.­çŠ÷š–
> Yž²Æ zËžÛh¶¬‚º.¥XžÃô^¦\ŽžX§{]tïž¡¶Úlÿ÷“h+¢êlŠàýׯz_æzˁïõ×NùèË­y8
> b±:)‰Èm¶›?þ
> 躛"£ù­ÿ]6ão<ë_õëø÷¡«¢êNÂw«uëÞ—ê0êÞvM ®‹©²*žË›±Êâmèm¶›?ýçdÚ
> 躛"£ø?uëÞ—û§²ææ‰ÈZzWdŠyÞÊ)ízW(


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#110762): https://edk2.groups.io/g/devel/message/110762
Mute This Topic: https://groups.io/mt/102428861/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/leave/3901457/1787277/102458076/xyzzy [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Q2xhcmlmeSB0byB1c2VycyB0aGF0IHRoZXkgc2hvdWxkIHJldmlldyB0aGUgYnVpbGQgbG9nIHdoZW4gbWFrZQooUE9TSVgtbGlrZSBzeXN0ZW0pIG9yIG5tYWtlIChXaW5kb3dzKSBmYWlscyB0byBjb21waWxlIGJhc2V0b29scy4KCkNjOiBSZWJlY2NhIENyYW4gPHJlYmVjY2FAYnNkaW8uY29tPgpDYzogTGltaW5nIEdhbyA8Z2FvbGltaW5nQGJ5b3NvZnQuY29tLmNuPgpDYzogQm9iIEZlbmcgPGJvYi5jLmZlbmdAaW50ZWwuY29tPgpDYzogWXV3ZWkgQ2hlbiA8eXV3ZWkuY2hlbkBpbnRlbC5jb20+ClNpZ25lZC1vZmYtYnk6IEpvZXkgVmFnZWRlcyA8am9leXZhZ2VkZXNAZ21haWwuY29tPgotLS0KIEJhc2VUb29scy9FZGsyVG9vbHNCdWlsZC5weSB8IDggKysrKysrLS0KIDEgZmlsZSBjaGFuZ2VkLCA2IGluc2VydGlvbnMoKyksIDIgZGVsZXRpb25zKC0pCgpkaWZmIC0tZ2l0IGEvQmFzZVRvb2xzL0VkazJUb29sc0J1aWxkLnB5IGIvQmFzZVRvb2xzL0VkazJUb29sc0J1aWxkLnB5CmluZGV4IDQyNWJiMWI2Mzk2My4uNDc3NmM1ODMwODBmIDEwMDY0NAotLS0gYS9CYXNlVG9vbHMvRWRrMlRvb2xzQnVpbGQucHkKKysrIGIvQmFzZVRvb2xzL0VkazJUb29sc0J1aWxkLnB5CkBAIC0xNDEsNyArMTQxLDkgQEAgY2xhc3MgRWRrMlRvb2xzQnVpbGQoQmFzZUFic3RyYWN0SW52b2NhYmxlKToKICAgICAgICAgICAgIGZvciBsZXZlbCwgcHJvYmxlbSBpbiBwcm9ibGVtczoNCiAgICAgICAgICAgICAgICAgbG9nZ2luZy5sb2cobGV2ZWwsIHByb2JsZW0pDQogICAgICAgICAgICAgaWYgcmV0ICE9IDA6DQotICAgICAgICAgICAgICAgIHJhaXNlIEV4Y2VwdGlvbigiRmFpbGVkIHRvIGJ1aWxkLiIpDQorICAgICAgICAgICAgICAgIGUgPSAiRmFpbGVkIHRvIHJ1biBubWFrZS5leGUuIFJldmlldyBCdWlsZGxvZyBhdCBCYXNlVG9vbHMvQmFzZVRvb2xzQnVpbGQvQkFTRVRPT0xTX0JVSUxELnR4dCBmb3Igbm1ha2UuZXhlIGVycm9yLiINCisgICAgICAgICAgICAgICAgbG9nZ2luZy5lcnJvcihlKQ0KKyAgICAgICAgICAgICAgICByZXR1cm4gcmV0DQogDQogICAgICAgICAgICAgc2VsZi5Xcml0ZVBhdGhFbnZGaWxlKHNlbGYuT3V0cHV0RGlyKQ0KICAgICAgICAgICAgIHJldHVybiByZXQNCkBAIC0xNTYsNyArMTU4LDkgQEAgY2xhc3MgRWRrMlRvb2xzQnVpbGQoQmFzZUFic3RyYWN0SW52b2NhYmxlKToKICAgICAgICAgICAgIGZvciBsZXZlbCwgcHJvYmxlbSBpbiBwcm9ibGVtczoNCiAgICAgICAgICAgICAgICAgbG9nZ2luZy5sb2cobGV2ZWwsIHByb2JsZW0pDQogICAgICAgICAgICAgaWYgcmV0ICE9IDA6DQotICAgICAgICAgICAgICAgIHJhaXNlIEV4Y2VwdGlvbigiRmFpbGVkIHRvIGJ1aWxkLiIpDQorICAgICAgICAgICAgICAgIGUgPSAiRmFpbGVkIHRvIHJ1biBtYWtlLiBSZXZpZXcgQnVpbGRsb2cgYXQgQmFzZVRvb2xzL0Jhc2VUb29sc0J1aWxkL0JBU0VUT09MU19CVUlMRC50eHQgZm9yIG1ha2UgZXJyb3IuIg0KKyAgICAgICAgICAgICAgICBsb2dnaW5nLmVycm9yKGUpDQorICAgICAgICAgICAgICAgIHJldHVybiByZXQNCiANCiAgICAgICAgICAgICBzZWxmLk91dHB1dERpciA9IG9zLnBhdGguam9pbigNCiAgICAgICAgICAgICAgICAgc2hlbGxfZW52LmdldF9zaGVsbF92YXIoIkVES19UT09MU19QQVRIIiksICJTb3VyY2UiLCAiQyIsICJiaW4iKQ0KLS0gCjIuMzQuMQoK-=-=-=-=-=-=-=-=-=-=-=-Groups.io Links: You receive all messages sent to this group.View/Reply Online (#110757): https://edk2.groups.io/g/devel/message/110757Mute This Topic: https://groups.io/mt/102428862/1787277Group Owner: devel+owner@edk2.groups.ioUnsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]-=-=-=-=-=-=-=-=-=-=-=-

Reviewed-by: Rebecca Cran <rebecca@bsdio.com>

-- 
Rebecca Cran

On 11/6/2023 1:12 PM, Joey Vagedes wrote:
> Clarify to users that they should review the build log when make
> (POSIX-like system) or nmake (Windows) fails to compile basetools.
>
> Cc: Rebecca Cran <rebecca@bsdio.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Bob Feng <bob.c.feng@intel.com>
> Cc: Yuwei Chen <yuwei.chen@intel.com>
> Signed-off-by: Joey Vagedes <joeyvagedes@gmail.com>
> ---
>   BaseTools/Edk2ToolsBuild.py | 8 ++++++--
>   1 file changed, 6 insertions(+), 2 deletions(-)
>
> diff --git a/BaseTools/Edk2ToolsBuild.py b/BaseTools/Edk2ToolsBuild.py
> index 425bb1b63963..4776c583080f 100644
> --- a/BaseTools/Edk2ToolsBuild.py
> +++ b/BaseTools/Edk2ToolsBuild.py
> @@ -141,7 +141,9 @@ class Edk2ToolsBuild(BaseAbstractInvocable):
>               for level, problem in problems:
>                   logging.log(level, problem)
>               if ret != 0:
> -                raise Exception("Failed to build.")
> +                e = "Failed to run nmake.exe. Review Buildlog at BaseTools/BaseToolsBuild/BASETOOLS_BUILD.txt for nmake.exe error."
> +                logging.error(e)
> +                return ret
>   
>               self.WritePathEnvFile(self.OutputDir)
>               return ret
> @@ -156,7 +158,9 @@ class Edk2ToolsBuild(BaseAbstractInvocable):
>               for level, problem in problems:
>                   logging.log(level, problem)
>               if ret != 0:
> -                raise Exception("Failed to build.")
> +                e = "Failed to run make. Review Buildlog at BaseTools/BaseToolsBuild/BASETOOLS_BUILD.txt for make error."
> +                logging.error(e)
> +                return ret
>   
>               self.OutputDir = os.path.join(
>                   shell_env.get_shell_var("EDK_TOOLS_PATH"), "Source", "C", "bin")




-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#110759): https://edk2.groups.io/g/devel/message/110759
Mute This Topic: https://groups.io/mt/102428862/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-