Re: [edk2-devel] [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode

["Michael Kubacki" <mikuback@linux.microsoft.com>]

I'm just trying to understand your position.

Are you saying you would rather people check in typos and then later 
have patches come into the package to fix them?

For example, like these:

- ArmVirtPkg: https://edk2.groups.io/g/devel/message/97021
- ArmPkg: https://edk2.groups.io/g/devel/message/97022

Why not just have the code checked in without typos in the first place?

Checking in typos creates more review work, makes the code history have 
typo fix patches that could be avoided, and impacts accessibility.

I spend far more time with edk2 overhead such as email formatting 
problems, keeping track of maintainer email address changes when 
updating patches, mapping email replies back to code, and so on that 
does not improve the code. A spell checker only takes seconds and is 
built into edk2 CI.

On 12/14/2022 6:24 PM, Ard Biesheuvel wrote:
> On Thu, 15 Dec 2022 at 00:21, Michael Kubacki
> <mikuback@linux.microsoft.com> wrote:
>>
>> Yes. It will also reduce frequency of incoming patches that must be
>> reviewed and merged due to people continuously fixing trivial spelling
>> errors.
>>
> 
> In that case, NAK to this patch (and the ArmVirtPkg one). Unless we
> add a button to the GitHub UI that permits me to override a negative
> CI result on a PR.
> 
>> On 12/14/2022 6:07 PM, Ard Biesheuvel wrote:
>>> On Wed, 14 Dec 2022 at 23:53, <mikuback@linux.microsoft.com> wrote:
>>>>
>>>> From: Michael Kubacki <michael.kubacki@microsoft.com>
>>>>
>>>> Audit mode was enabled for the spellcheck CI plugin. It is no longer
>>>> needed with recent changes. Spelling errors can be checked in the
>>>> package moving forward.
>>>>
>>>> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
>>>> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
>>>> Cc: Sami Mujawar <sami.mujawar@arm.com>
>>>> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
>>>
>>> Will this patch result in PRs potentially being rejected by pre-merge
>>> CI due to trivial spelling errors?
>>>
>>>
>>>> ---
>>>>    ArmPkg/ArmPkg.ci.yaml | 3 ++-
>>>>    1 file changed, 2 insertions(+), 1 deletion(-)
>>>>
>>>> diff --git a/ArmPkg/ArmPkg.ci.yaml b/ArmPkg/ArmPkg.ci.yaml
>>>> index c8dface6821a..a304c7966cf7 100644
>>>> --- a/ArmPkg/ArmPkg.ci.yaml
>>>> +++ b/ArmPkg/ArmPkg.ci.yaml
>>>> @@ -87,7 +87,7 @@
>>>>
>>>>        ## options defined .pytool/Plugin/SpellCheck
>>>>        "SpellCheck": {
>>>> -        "AuditOnly": True,
>>>> +        "AuditOnly": False,
>>>>            "IgnoreFiles": [
>>>>                "Library/ArmSoftFloatLib/berkeley-softfloat-3/**"
>>>>            ],                           # use gitignore syntax to ignore errors
>>>> @@ -148,6 +148,7 @@
>>>>              "fcmplt",
>>>>              "ffreestanding",
>>>>              "frsub",
>>>> +          "hauser",
>>>>              "hisilicon",
>>>>              "iccabpr",
>>>>              "iccbpr",
>>>> --
>>>> 2.28.0.windows.1
>>>>
> 
> 
> 
>