[PATCH v1 1/1] .pytool/Plugin/UncrustifyCheck: Add Azure DevOps UI debug instructions

[PATCH v1 1/1] .pytool/Plugin/UncrustifyCheck: Add Azure DevOps UI debug instructions

[Michael Kubacki]

From: Michael Kubacki <michael.kubacki@microsoft.com>

Adds a link to the log output that contains instructions on how find
detailed file formatting errors in the Azure DevOps UI.

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
 .pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/.pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py b/.pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py
index 22cca0ff1101..00d78864656f 100644
--- a/.pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py
+++ b/.pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py
@@ -562,6 +562,11 @@ class UncrustifyCheck(ICiBuildPlugin):
         self._formatted_file_error_count = len(formatted_files)
 
         if self._formatted_file_error_count > 0:
+            logging.error(
+                "Visit the following instructions to learn "
+                "how to find the detailed formatting errors in Azure "
+                "DevOps CI: "
+                "https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Code-Formatting#how-to-find-uncrustify-formatting-errors-in-continuous-integration-ci")
             self._tc.LogStdError("Files with formatting errors:\n")
 
             if self._output_file_diffs:
-- 
2.28.0.windows.1

Re: [edk2-devel] [PATCH v1 1/1] .pytool/Plugin/UncrustifyCheck: Add Azure DevOps UI debug instructions

[Sean]

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

Reviewed-by: Sean Brogan <sean.brogan@microsoft.com>

[-- Attachment #2: Type: text/html, Size: 60 bytes --]

Re: [edk2-devel] [PATCH v1 1/1] .pytool/Plugin/UncrustifyCheck: Add Azure DevOps UI debug instructions

[Michael Kubacki]

PR with R-b tag is ready to push:

https://github.com/tianocore/edk2/pull/2799

On 4/21/2022 5:08 PM, Sean wrote:
> Reviewed-by: Sean Brogan <sean.brogan@microsoft.com>