]> git.proxmox.com Git - mirror_edk2.git/commit
.pytool/Plugin/UncrustifyCheck: Add ignore file support
authorMichael Kubacki <michael.kubacki@microsoft.com>
Mon, 21 Mar 2022 19:59:07 +0000 (15:59 -0400)
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Mon, 4 Apr 2022 15:18:31 +0000 (15:18 +0000)
commitdbfbaedb21c94ef8344086ba6532e964e40f5526
tree4881cd95fadd84b724bbb3c0f1b0f350c905a1ba
parentf16b05a13bb3a4c685c4c6161c1367e43fcd61f7
.pytool/Plugin/UncrustifyCheck: Add ignore file support

REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3880

Currently UncrustifyCheck.py provides the following exclusion
options:

1. Override the type of files UncrustifyCheck operates against by
default (.c and .h files). Using the "IgnoreStandardPaths"
configuration option.

2. By default, UncrustifyCheck skips files in git submodules and
ignored by git (the "SkipGitExclusions" configuration option can
override this behavior).

The goal of UncrustifyCheck is to provide consistent formatting
across the codebase. In some rare circumstances, maintainers might
need to exclude a specific file (or file pattern) within their
package. For example, a small set of auto-generated files from
another repository.

This change adds a new configuration option that can be specified
in a package CI YAML file to describe a list of files within the
package that should be ignored by UncrustifyCheck.

The configuration option is called "IgnoreFiles" and it uses similar
syntax to git ignore to ignore a list of files.

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: Jiewen Yao <jiewen.yao@intel.com>
Reviewed-by: Sean Brogan <sean.brogan@microsoft.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
.pytool/Plugin/UncrustifyCheck/Readme.md
.pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py