diff options
| author | Michael Kubacki <michael.kubacki@microsoft.com> | 2021-12-06 07:22:22 -0800 |
|---|---|---|
| committer | mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> | 2021-12-07 18:51:02 +0000 |
| commit | dc453b51640f945233a1edb062c0c97f88c21e79 (patch) | |
| tree | 789a6320e10c7e280092720d05ed33d63161446a /.pytool/Readme.md | |
| parent | 7c0ad2c33810ead45b7919f8f8d0e282dae52e71 (diff) | |
| download | edk2-dc453b51640f945233a1edb062c0c97f88c21e79.tar.gz | |
.pytool/Plugin/UncrustifyCheck: Add Uncrustify CI plugin
REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3748
Adds a new CI plugin for Uncrustify. This is used to check
coding standard compliance of source code to the EDK II C Coding
Standards Specification.
An external dependency is added in the plugin directory to retrieve
the Uncrustify executable. Currently, the executable is from an edk2
fork of the application host in this repository:
https://dev.azure.com/projectmu/Uncrustify/
Note that the Uncrustify application outputs the commit ID that the
application was built from when given the --version parameter.
This ID can be mapped to the version specified in the Uncrustify CI
plugin external dependency file (uncrustify_ext_dep.yaml) such as
73.0.3 by visiting the Uncrustify edk2 fork release pipeline page
which associates the NuGet package version with the commit ID it was
built from:
https://dev.azure.com/projectmu/Uncrustify/_build
The default Uncrustify configuration files are added in the plugin
directory. Additional details are in the Readme.md file added in
the Uncrustify plugin directory.
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>
Reviewed-by: Bret Barkelew <bret.barkelew@microsoft.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
Tested-by: Michael D Kinney <michael.d.kinney@intel.com>
Diffstat (limited to '.pytool/Readme.md')
| -rw-r--r-- | .pytool/Readme.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/.pytool/Readme.md b/.pytool/Readme.md index f650550796..e0d07f3170 100644 --- a/.pytool/Readme.md +++ b/.pytool/Readme.md @@ -264,6 +264,10 @@ BSD-2-Clause-Patent. Run the Ecc tool on the package. The Ecc tool is available in the BaseTools
package. It checks that the code complies to the EDKII coding standard.
+### Coding Standard Compliance - UncrustifyCheck
+
+Runs the Uncrustify application to check for coding standard compliance issues.
+
## PyTool Scopes
Scopes are how the PyTool ext_dep, path_env, and plugins are activated. Meaning
|