[edk2-devel][PATCH v1 1/1] CharEncodingCheckPlugin: Remove Noisy Print

[edk2-devel][PATCH v1 1/1] CharEncodingCheckPlugin: Remove Noisy Print

[Oliver Smith-Denny]

Currently, CharEncodingCheckPlugin prints a message for every
file that passes the test, which for some platforms can cause
most of the CI build log to be filled with this print. It does
not add any value, so this patch removes the noisy print and
only prints if the encoding check fails.

Github PR: https://github.com/tianocore/edk2/pull/4472

Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Michael Kubacki <mikuback@linux.microsoft.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>

Signed-off-by: Oliver Smith-Denny <osde@linux.microsoft.com>
---
 .pytool/Plugin/CharEncodingCheck/CharEncodingCheck.py | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/.pytool/Plugin/CharEncodingCheck/CharEncodingCheck.py b/.pytool/Plugin/CharEncodingCheck/CharEncodingCheck.py
index b09fb1704087..07d9e9ce223e 100644
--- a/.pytool/Plugin/CharEncodingCheck/CharEncodingCheck.py
+++ b/.pytool/Plugin/CharEncodingCheck/CharEncodingCheck.py
@@ -93,9 +93,7 @@ class CharEncodingCheck(ICiBuildPlugin):
             files = [Edk2pathObj.GetAbsolutePathOnThisSystemFromEdk2RelativePath(x) for x in files]
             for a in files:
                 files_tested += 1
-                if(self.TestEncodingOk(a, enc)):
-                    logging.debug("File {0} Passed Encoding Check {1}".format(a, enc))
-                else:
+                if not self.TestEncodingOk(a, enc):
                     tc.LogStdError("Encoding Failure in {0}.  Not {1}".format(a, enc))
                     overall_status += 1
 
-- 
2.40.1

Re: [edk2-devel][PATCH v1 1/1] CharEncodingCheckPlugin: Remove Noisy Print

[Michael D Kinney]

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


> -----Original Message-----
> From: Oliver Smith-Denny <osde@linux.microsoft.com>
> Sent: Friday, June 2, 2023 1:45 PM
> To: devel@edk2.groups.io
> Cc: Sean Brogan <sean.brogan@microsoft.com>; Michael Kubacki
> <mikuback@linux.microsoft.com>; Kinney, Michael D
> <michael.d.kinney@intel.com>; Gao, Liming <gaoliming@byosoft.com.cn>
> Subject: [edk2-devel][PATCH v1 1/1] CharEncodingCheckPlugin: Remove Noisy
> Print
> 
> Currently, CharEncodingCheckPlugin prints a message for every
> file that passes the test, which for some platforms can cause
> most of the CI build log to be filled with this print. It does
> not add any value, so this patch removes the noisy print and
> only prints if the encoding check fails.
> 
> Github PR: https://github.com/tianocore/edk2/pull/4472
> 
> Cc: Sean Brogan <sean.brogan@microsoft.com>
> Cc: Michael Kubacki <mikuback@linux.microsoft.com>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> 
> Signed-off-by: Oliver Smith-Denny <osde@linux.microsoft.com>
> ---
>  .pytool/Plugin/CharEncodingCheck/CharEncodingCheck.py | 4 +---
>  1 file changed, 1 insertion(+), 3 deletions(-)
> 
> diff --git a/.pytool/Plugin/CharEncodingCheck/CharEncodingCheck.py
> b/.pytool/Plugin/CharEncodingCheck/CharEncodingCheck.py
> index b09fb1704087..07d9e9ce223e 100644
> --- a/.pytool/Plugin/CharEncodingCheck/CharEncodingCheck.py
> +++ b/.pytool/Plugin/CharEncodingCheck/CharEncodingCheck.py
> @@ -93,9 +93,7 @@ class CharEncodingCheck(ICiBuildPlugin):
>              files =
> [Edk2pathObj.GetAbsolutePathOnThisSystemFromEdk2RelativePath(x) for x in
> files]
>              for a in files:
>                  files_tested += 1
> -                if(self.TestEncodingOk(a, enc)):
> -                    logging.debug("File {0} Passed Encoding Check
> {1}".format(a, enc))
> -                else:
> +                if not self.TestEncodingOk(a, enc):
>                      tc.LogStdError("Encoding Failure in {0}.  Not
> {1}".format(a, enc))
>                      overall_status += 1
> 
> --
> 2.40.1

Re: [edk2-devel][PATCH v1 1/1] CharEncodingCheckPlugin: Remove Noisy Print

[Michael Kubacki]

Reviewed-by: Michael Kubacki <michael.kubacki@microsoft.com>

On 6/2/2023 4:45 PM, Oliver Smith-Denny wrote:
> Currently, CharEncodingCheckPlugin prints a message for every
> file that passes the test, which for some platforms can cause
> most of the CI build log to be filled with this print. It does
> not add any value, so this patch removes the noisy print and
> only prints if the encoding check fails.
> 
> Github PR: https://github.com/tianocore/edk2/pull/4472
> 
> Cc: Sean Brogan <sean.brogan@microsoft.com>
> Cc: Michael Kubacki <mikuback@linux.microsoft.com>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> 
> Signed-off-by: Oliver Smith-Denny <osde@linux.microsoft.com>
> ---
>   .pytool/Plugin/CharEncodingCheck/CharEncodingCheck.py | 4 +---
>   1 file changed, 1 insertion(+), 3 deletions(-)
> 
> diff --git a/.pytool/Plugin/CharEncodingCheck/CharEncodingCheck.py b/.pytool/Plugin/CharEncodingCheck/CharEncodingCheck.py
> index b09fb1704087..07d9e9ce223e 100644
> --- a/.pytool/Plugin/CharEncodingCheck/CharEncodingCheck.py
> +++ b/.pytool/Plugin/CharEncodingCheck/CharEncodingCheck.py
> @@ -93,9 +93,7 @@ class CharEncodingCheck(ICiBuildPlugin):
>               files = [Edk2pathObj.GetAbsolutePathOnThisSystemFromEdk2RelativePath(x) for x in files]
>               for a in files:
>                   files_tested += 1
> -                if(self.TestEncodingOk(a, enc)):
> -                    logging.debug("File {0} Passed Encoding Check {1}".format(a, enc))
> -                else:
> +                if not self.TestEncodingOk(a, enc):
>                       tc.LogStdError("Encoding Failure in {0}.  Not {1}".format(a, enc))
>                       overall_status += 1
>