Re: [RFC PATCH] ArmPkg: Enable AuditMode for Uncrustify CI checks

["Leif Lindholm" <quic_llindhol@quicinc.com>]

On Fri, Jun 02, 2023 at 10:51:36 +0200, Ard Biesheuvel wrote:
> Uncrustify checks are too rigid, making them counter-productive:
> 
> - it leads to code that is arguably harder to parse visually (e.g.,
>   the changes to ArmPkg/Include/Chipset/AArch64Mmu.h in commit
>   429309e0c6b74792)
> - it forces indentation-only changes to code in the vicinity of actual
>   changes, making the code history more bloated than necessary (see
>   commit 7f198321eec0f520373 for an example)
> - finding out from the web UI what exactly Uncrustify objected to is not
>   straight-forward.
> 
> So let's enable AuditMode for ArmPkg, so that interested parties can see
> the uncrustify recommendations if desired, but without preventing the
> changes from being merged. This leaves it at the discretion of the
> ArmPkg maintainers to decide which level of conformance is required.
> 
> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
> Cc: "Kinney, Michael D" <michael.d.kinney@intel.com>
> Cc: Michael Kubacki <mikuback@linux.microsoft.com>
> Signed-off-by: Ard Biesheuvel <ardb@kernel.org>

Reviewed-by: Leif Lindholm <quic_llindhol@quicinc.com>

I'm going to merge this - at least for now - since some of the quirks
are holding back merging code that is compliant because of existing
things it takes an issue with elsewhere in the file.

/
    Leif

> ---
>  ArmPkg/ArmPkg.ci.yaml | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/ArmPkg/ArmPkg.ci.yaml b/ArmPkg/ArmPkg.ci.yaml
> index 24db7425051388cf..d3124816118944cb 100644
> --- a/ArmPkg/ArmPkg.ci.yaml
> +++ b/ArmPkg/ArmPkg.ci.yaml
> @@ -239,5 +239,10 @@
>          ],
>          "AdditionalIncludePaths": [] # Additional paths to spell check
>                                       # (wildcards supported)
> +    },
> +
> +    # options defined in .pytool/Plugin/UncrustifyCheck
> +    "UncrustifyCheck": {
> +        "AuditOnly": True
>      }
>  }
> -- 
> 2.39.2
>