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


Michael Kubacki
 

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

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@...>
Cc: Liming Gao <gaoliming@...>
Cc: Sean Brogan <sean.brogan@...>
Cc: Bret Barkelew <Bret.Barkelew@...>
Signed-off-by: Michael Kubacki <michael.kubacki@...>
---
.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 =3D len(formatted_files)
=20
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/E=
DK-II-Code-Formatting#how-to-find-uncrustify-formatting-errors-in-continu=
ous-integration-ci")
self._tc.LogStdError("Files with formatting errors:\n")
=20
if self._output_file_diffs:
--=20
2.28.0.windows.1

Join devel@edk2.groups.io to automatically receive all group messages.