[PATCH v1 0/4] Update Node to 14.x to resolve cspell failure

[PATCH v1 0/4] Update Node to 14.x to resolve cspell failure

[Kun Qin]

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

According to requirements set by cspell, the minimal node version to
support cspell v5+ should be 12 or above (ref:
https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell).

This mismatched dependency caused "Failed to process "**" TypeError:
text.matchAll(...) is not a function or its return value is not iterable"
errors on multiple files during spell check, and they have been ignored
silently.

This change will update the node dependency to be at least v14 to fix
incompatibility issue. With this resolved, the newly discovered
misspellings are handled accordingly:
* Spelling error in StandaloneMM get fixed.
* Spelling errors in ArmPkg are added to package config for their validity.
* Spelling errors in ArmPlatformPkg is set to audit mode and request the
maintainers resolve the errors.

Patch v1 branch: https://github.com/kuqin12/edk2/tree/node_14_v1

Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Supreeth Venkatesh <supreeth.venkatesh@arm.com>

Kun Qin (1):
  Azurepipeline: SpellCheck: Enforce Node dependency to use version 14.x

Sean Brogan (3):
  StandaloneMmPkg: Core: Spelling error in comment
  ArmPlatformPkg: SpellCheck: Switch spellcheck CI to AuditOnly
  ArmPkg: SpellCheck: Update valid acronyms in ExtendedWords

 StandaloneMmPkg/Core/Dispatcher.c                      |  2 +-
 .azurepipelines/templates/spell-check-prereq-steps.yml |  2 +-
 ArmPkg/ArmPkg.ci.yaml                                  | 19 +++++++++++++++++++
 ArmPlatformPkg/ArmPlatformPkg.ci.yaml                  |  2 +-
 4 files changed, 22 insertions(+), 3 deletions(-)

-- 
2.31.1.windows.1

[PATCH v1 1/4] StandaloneMmPkg: Core: Spelling error in comment

[Kun Qin]

From: Sean Brogan <sean.brogan@microsoft.com>

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

This change fixed a misspelling that was not caught by spell check.

Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Supreeth Venkatesh <supreeth.venkatesh@arm.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>

Signed-off-by: Sean Brogan <sean.brogan@microsoft.com>
---
 StandaloneMmPkg/Core/Dispatcher.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/StandaloneMmPkg/Core/Dispatcher.c b/StandaloneMmPkg/Core/Dispatcher.c
index dbd5332fa9d3..7e4bf5e94025 100644
--- a/StandaloneMmPkg/Core/Dispatcher.c
+++ b/StandaloneMmPkg/Core/Dispatcher.c
@@ -4,7 +4,7 @@
   Step #1 - When a FV protocol is added to the system every driver in the FV
             is added to the mDiscoveredList. The Before, and After Depex are
             pre-processed as drivers are added to the mDiscoveredList. If an Apriori
-            file exists in the FV those drivers are addeded to the
+            file exists in the FV those drivers are added to the
             mScheduledQueue. The mFwVolList is used to make sure a
             FV is only processed once.
 
-- 
2.31.1.windows.1

Re: [PATCH v1 1/4] StandaloneMmPkg: Core: Spelling error in comment

[Ard Biesheuvel]

On Sat, 12 Jun 2021 at 05:44, Kun Qin <kuqin12@gmail.com> wrote:
>
> From: Sean Brogan <sean.brogan@microsoft.com>
>
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3445
>
> This change fixed a misspelling that was not caught by spell check.
>
> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> Cc: Sami Mujawar <sami.mujawar@arm.com>
> Cc: Jiewen Yao <jiewen.yao@intel.com>
> Cc: Supreeth Venkatesh <supreeth.venkatesh@arm.com>
> Cc: Sean Brogan <sean.brogan@microsoft.com>
>
> Signed-off-by: Sean Brogan <sean.brogan@microsoft.com>

Hello Kun Qin,

When you send patches to the list that were authored by someone else,
you should add your own signoff, and add it last. (The signoff means
that you attest that the patch is contributed under terms that are
compatible with the open source licenses we support. The signoff has
nothing to do with recognizing authorship, so even if someone else did
most of the work, if that person is not involved in contributing these
changes, their name does not need to appear in the Git log.)

Sean is the author, which will be reflected in the git log anyway, so
his signoff does not have any significance here, as he is not the one
sending the patch to the public mailing list.

Usually, I would fix up minor issues like these when merging the
changes, but adding a signoff on someone else's behalf is the one
thing I can never do.

So please fix this up, and then you can add

Reviewed-by: Ard Biesheuvel <ardb@kernel.org>

to the entire series.

Thanks,



> ---
>  StandaloneMmPkg/Core/Dispatcher.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/StandaloneMmPkg/Core/Dispatcher.c b/StandaloneMmPkg/Core/Dispatcher.c
> index dbd5332fa9d3..7e4bf5e94025 100644
> --- a/StandaloneMmPkg/Core/Dispatcher.c
> +++ b/StandaloneMmPkg/Core/Dispatcher.c
> @@ -4,7 +4,7 @@
>    Step #1 - When a FV protocol is added to the system every driver in the FV
>              is added to the mDiscoveredList. The Before, and After Depex are
>              pre-processed as drivers are added to the mDiscoveredList. If an Apriori
> -            file exists in the FV those drivers are addeded to the
> +            file exists in the FV those drivers are added to the
>              mScheduledQueue. The mFwVolList is used to make sure a
>              FV is only processed once.
>
> --
> 2.31.1.windows.1
>

Re: [PATCH v1 1/4] StandaloneMmPkg: Core: Spelling error in comment

[Kun Qin]

Hi Ard,

Sorry for the confusion and thanks for providing the r-b tag.

This should be fixed in v2 patches: 
https://edk2.groups.io/g/devel/message/76479

Regards,
Kun

On 06/12/2021 01:22, Ard Biesheuvel wrote:
> On Sat, 12 Jun 2021 at 05:44, Kun Qin <kuqin12@gmail.com> wrote:
>>
>> From: Sean Brogan <sean.brogan@microsoft.com>
>>
>> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3445
>>
>> This change fixed a misspelling that was not caught by spell check.
>>
>> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
>> Cc: Sami Mujawar <sami.mujawar@arm.com>
>> Cc: Jiewen Yao <jiewen.yao@intel.com>
>> Cc: Supreeth Venkatesh <supreeth.venkatesh@arm.com>
>> Cc: Sean Brogan <sean.brogan@microsoft.com>
>>
>> Signed-off-by: Sean Brogan <sean.brogan@microsoft.com>
> 
> Hello Kun Qin,
> 
> When you send patches to the list that were authored by someone else,
> you should add your own signoff, and add it last. (The signoff means
> that you attest that the patch is contributed under terms that are
> compatible with the open source licenses we support. The signoff has
> nothing to do with recognizing authorship, so even if someone else did
> most of the work, if that person is not involved in contributing these
> changes, their name does not need to appear in the Git log.)
> 
> Sean is the author, which will be reflected in the git log anyway, so
> his signoff does not have any significance here, as he is not the one
> sending the patch to the public mailing list.
> 
> Usually, I would fix up minor issues like these when merging the
> changes, but adding a signoff on someone else's behalf is the one
> thing I can never do.
> 
> So please fix this up, and then you can add
> 
> Reviewed-by: Ard Biesheuvel <ardb@kernel.org>
> 
> to the entire series.
> 
> Thanks,
> 
> 
> 
>> ---
>>   StandaloneMmPkg/Core/Dispatcher.c | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/StandaloneMmPkg/Core/Dispatcher.c b/StandaloneMmPkg/Core/Dispatcher.c
>> index dbd5332fa9d3..7e4bf5e94025 100644
>> --- a/StandaloneMmPkg/Core/Dispatcher.c
>> +++ b/StandaloneMmPkg/Core/Dispatcher.c
>> @@ -4,7 +4,7 @@
>>     Step #1 - When a FV protocol is added to the system every driver in the FV
>>               is added to the mDiscoveredList. The Before, and After Depex are
>>               pre-processed as drivers are added to the mDiscoveredList. If an Apriori
>> -            file exists in the FV those drivers are addeded to the
>> +            file exists in the FV those drivers are added to the
>>               mScheduledQueue. The mFwVolList is used to make sure a
>>               FV is only processed once.
>>
>> --
>> 2.31.1.windows.1
>>

[PATCH v1 2/4] ArmPlatformPkg: SpellCheck: Switch spellcheck CI to AuditOnly

[Kun Qin]

From: Sean Brogan <sean.brogan@microsoft.com>

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

Spellcheck was not covering all specified files due to CSpell v5 and
Node v10 incompatibility of current CI pipeline configuration.

This change switches the spellcheck for ArmPlatformPkg to AuditOnly to
avoid potentially numerous spell errors. The correction action is to be
revisited by package maintainers once the tool incompatibility is
resolved.

Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>

Signed-off-by: Kun Qin <kuqin12@gmail.com>
Signed-off-by: Sean Brogan <sean.brogan@microsoft.com>
---
 ArmPlatformPkg/ArmPlatformPkg.ci.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ArmPlatformPkg/ArmPlatformPkg.ci.yaml b/ArmPlatformPkg/ArmPlatformPkg.ci.yaml
index 1abaa2f6870c..3dbbcc673bf0 100644
--- a/ArmPlatformPkg/ArmPlatformPkg.ci.yaml
+++ b/ArmPlatformPkg/ArmPlatformPkg.ci.yaml
@@ -83,7 +83,7 @@
 
     ## options defined .pytool/Plugin/SpellCheck
     "SpellCheck": {
-        "AuditOnly": False,
+        "AuditOnly": True,
         "IgnoreFiles": [],           # use gitignore syntax to ignore errors
                                      # in matching files
         "ExtendWords": [
-- 
2.31.1.windows.1

[PATCH v1 3/4] ArmPkg: SpellCheck: Update valid acronyms in ExtendedWords

[Kun Qin]

From: Sean Brogan <sean.brogan@microsoft.com>

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

Spellcheck was not covering all specified files due to CSpell v5 and
Node v10 incompatibility of current CI pipeline configuration.

This change updates ExtendedWords for ArmPkg with valid acronyms to avoid
potential spell errors.

Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Sami Mujawar <sami.mujawar@arm.com>

Signed-off-by: Kun Qin <kuqin12@gmail.com>
Signed-off-by: Sean Brogan <sean.brogan@microsoft.com>
---
 ArmPkg/ArmPkg.ci.yaml | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/ArmPkg/ArmPkg.ci.yaml b/ArmPkg/ArmPkg.ci.yaml
index d91c03f2acb8..a0d6a75fe881 100644
--- a/ArmPkg/ArmPkg.ci.yaml
+++ b/ArmPkg/ArmPkg.ci.yaml
@@ -94,13 +94,18 @@
           "ackintid",
           "actlr",
           "aeabi",
+          "asedis",
           "ashldi",
           "ashrdi",
+          "baddr",
           "ccidx",
           "ccsidr",
           "clidr",
           "clrex",
           "clzsi",
+          "cnthctl",
+          "cortexa",
+          "cpacr",
           "cpuactlr",
           "csselr",
           "ctzsi",
@@ -116,6 +121,7 @@
           "divdi",
           "divsi",
           "dmdepkg",
+          "dpref",
           "drsub",
           "fcmpeq",
           "fcmpge",
@@ -125,17 +131,25 @@
           "ffreestanding",
           "frsub",
           "hisilicon",
+          "iccabpr",
           "iccbpr",
           "icciar",
           "iccicr",
           "icciidr",
+          "iccpir",
           "iccpmr",
+          "iccrpr",
+          "icdabr",
           "icdicer",
           "icdicfr",
+          "icdicpr",
           "icdictr",
+          "icdiidr",
           "icdiser",
           "icdisr",
+          "icdppisr",
           "icdsgir",
+          "icdspr",
           "icenabler",
           "intid",
           "ipriority",
@@ -160,6 +174,7 @@
           "lshrdi",
           "moddi",
           "modsi",
+          "mpcore",
           "mpidr",
           "muldi",
           "mullu",
@@ -168,6 +183,9 @@
           "nsasedis",
           "nuvia",
           "oldit",
+          "pcten",
+          "plpis",
+          "procno",
           "readc",
           "revsh",
           "rfedb",
@@ -189,6 +207,7 @@
           "smmlsr",
           "sourcery",
           "srsdb",
+          "ssacr",
           "stmdb",
           "stmia",
           "strbt",
-- 
2.31.1.windows.1

Re: [PATCH v1 3/4] ArmPkg: SpellCheck: Update valid acronyms in ExtendedWords

[Laszlo Ersek]

Hi,

On 06/12/21 05:44, Kun Qin wrote:
> From: Sean Brogan <sean.brogan@microsoft.com>
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3445
> 
> Spellcheck was not covering all specified files due to CSpell v5 and
> Node v10 incompatibility of current CI pipeline configuration.
> 
> This change updates ExtendedWords for ArmPkg with valid acronyms to avoid
> potential spell errors.
> 
> Cc: Laszlo Ersek <lersek@redhat.com>
> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> Cc: Leif Lindholm <leif@nuviainc.com>
> Cc: Sami Mujawar <sami.mujawar@arm.com>
> 
> Signed-off-by: Kun Qin <kuqin12@gmail.com>
> Signed-off-by: Sean Brogan <sean.brogan@microsoft.com>
> ---
>  ArmPkg/ArmPkg.ci.yaml | 19 +++++++++++++++++++
>  1 file changed, 19 insertions(+)

I'm not an ArmPkg reviewer, so I'm not sure about the Cc.

That said, the patch seems sensible and I guess the sorting should be
OK; the actual mnemonics should be checked by others however :)

Acked-by: Laszlo Ersek <lersek@redhat.com>

Thanks
Laszlo

> 
> diff --git a/ArmPkg/ArmPkg.ci.yaml b/ArmPkg/ArmPkg.ci.yaml
> index d91c03f2acb8..a0d6a75fe881 100644
> --- a/ArmPkg/ArmPkg.ci.yaml
> +++ b/ArmPkg/ArmPkg.ci.yaml
> @@ -94,13 +94,18 @@
>            "ackintid",
>            "actlr",
>            "aeabi",
> +          "asedis",
>            "ashldi",
>            "ashrdi",
> +          "baddr",
>            "ccidx",
>            "ccsidr",
>            "clidr",
>            "clrex",
>            "clzsi",
> +          "cnthctl",
> +          "cortexa",
> +          "cpacr",
>            "cpuactlr",
>            "csselr",
>            "ctzsi",
> @@ -116,6 +121,7 @@
>            "divdi",
>            "divsi",
>            "dmdepkg",
> +          "dpref",
>            "drsub",
>            "fcmpeq",
>            "fcmpge",
> @@ -125,17 +131,25 @@
>            "ffreestanding",
>            "frsub",
>            "hisilicon",
> +          "iccabpr",
>            "iccbpr",
>            "icciar",
>            "iccicr",
>            "icciidr",
> +          "iccpir",
>            "iccpmr",
> +          "iccrpr",
> +          "icdabr",
>            "icdicer",
>            "icdicfr",
> +          "icdicpr",
>            "icdictr",
> +          "icdiidr",
>            "icdiser",
>            "icdisr",
> +          "icdppisr",
>            "icdsgir",
> +          "icdspr",
>            "icenabler",
>            "intid",
>            "ipriority",
> @@ -160,6 +174,7 @@
>            "lshrdi",
>            "moddi",
>            "modsi",
> +          "mpcore",
>            "mpidr",
>            "muldi",
>            "mullu",
> @@ -168,6 +183,9 @@
>            "nsasedis",
>            "nuvia",
>            "oldit",
> +          "pcten",
> +          "plpis",
> +          "procno",
>            "readc",
>            "revsh",
>            "rfedb",
> @@ -189,6 +207,7 @@
>            "smmlsr",
>            "sourcery",
>            "srsdb",
> +          "ssacr",
>            "stmdb",
>            "stmia",
>            "strbt",
> 

[PATCH v1 4/4] Azurepipeline: SpellCheck: Enforce Node dependency to use version 14.x

[Kun Qin]

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

Per update from Cspell tool, the minimal requirement of Cspell 5.x
regarding Node is 12 and above. This has caused multple Cspell failures
during CI build validation:
"Failed to process "**.c" TypeError: text.matchAll(...) is not a function
or its return value is not iterable"

This change updates the lowest required node version to 14.x to support
Cspell functionalities.

Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>

Signed-off-by: Kun Qin <kuqin12@gmail.com>
---
 .azurepipelines/templates/spell-check-prereq-steps.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.azurepipelines/templates/spell-check-prereq-steps.yml b/.azurepipelines/templates/spell-check-prereq-steps.yml
index e1570d4f2aac..98ee3cfa6bc6 100644
--- a/.azurepipelines/templates/spell-check-prereq-steps.yml
+++ b/.azurepipelines/templates/spell-check-prereq-steps.yml
@@ -13,7 +13,7 @@ parameters:
 steps:
 - task: NodeTool@0
   inputs:
-    versionSpec: '10.x'
+    versionSpec: '14.x'
     #checkLatest: false # Optional
   condition: and(gt(variables.pkg_count, 0), succeeded())
 
-- 
2.31.1.windows.1