[edk2-devel] [PATCH v2 00/11] Fix new typos reported

Michael Kubacki mikuback at linux.microsoft.com
Wed May 18 00:13:27 UTC 2022


From: Michael Kubacki <michael.kubacki at microsoft.com>

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

The SpellCheck plugin began reporting new typos that were previously
missed. This is impacting edk2 pull requests from being completed.

A change in the cspell plugin or some other upstream component may
have caused them to appear now. This patch series mitigates the
issue by fixing legitimate spelling issues and adding new ignored
words if appropriate.

It also locks the cspell version instead of moving with latest to
prevent future updates from unexpectedly changing results. Other
changes are made as noted in the V2 changes to reduce overhead
introduced by the plugin in the future.

V2 changes:
  1. Complete BZ 3929.
  2. Lock the cspell version to v5.20.0 to prevent latest from
     unexpectedly causing issues in the future.
  3. Update the common word list in cspell.base.yaml to prevent package
     level duplication in the future.
  4. Set "allowCompoundWords" to "true" to better recognize compound words.
  4. Include code review tags.
  
Cc: Alexei Fedorov <Alexei.Fedorov at arm.com>
Cc: Ankit Sinha <ankit.sinha at intel.com>
Cc: Ard Biesheuvel <ardb+tianocore at kernel.org>
Cc: Bret Barkelew <Bret.Barkelew at microsoft.com>
Cc: Gerd Hoffmann <kraxel at redhat.com>
Cc: Guomin Jiang <guomin.jiang at intel.com>
Cc: Jiewen Yao <jiewen.yao at intel.com>
Cc: Leif Lindholm <quic_llindhol at quicinc.com>
Cc: Liming Gao <gaoliming at byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney at intel.com>
Cc: Michael Kubacki <mikuback at linux.microsoft.com>
Cc: Nate DeSimone <nathaniel.l.desimone at intel.com>
Cc: Ray Ni <ray.ni at intel.com>
Cc: Sami Mujawar <sami.mujawar at arm.com>
Cc: Sean Brogan <sean.brogan at microsoft.com>
Cc: Supreeth Venkatesh <supreeth.venkatesh at arm.com>
Cc: Wei6 Xu <wei6.xu at intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki at microsoft.com>

Michael Kubacki (11):
  PrmPkg: Fix new typos reported
  StandaloneMmPkg: Fix new typos reported
  DynamicTablesPkg: Fix new typos reported
  UnitTestFrameworkPkg: Fix new typos reported
  FatPkg: Fix new typos reported
  FmpDevicePkg: Fix new typos reported
  ArmPkg: Ignore new typos reported
  ArmVirtPkg: Add new ignored spelling errors
  .azurepipelines: Fix cspell version to v5.20.0
  .pytool/plugin/SpellCheck: Allow compound words
  .pytool/plugin/SpellCheck: Add more common words

 ArmPkg/Drivers/ArmScmiDxe/Scmi.c                                                                         |   2 +-
 ArmPkg/Library/ArmDisassemblerLib/ThumbDisassembler.c                                                    |   4 +-
 ArmPkg/Library/SemiHostingSerialPortLib/SerialPortLib.c                                                  |   2 +-
 ArmPkg/Library/StandaloneMmMmuLib/ArmMmuStandaloneMmLib.c                                                |   6 +-
 ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLib.c                                                      |   2 +-
 DynamicTablesPkg/Library/Acpi/Arm/AcpiPpttLibArm/PpttGenerator.c                                         |   2 +-
 DynamicTablesPkg/Library/Acpi/Arm/AcpiSsdtCmn600LibArm/SsdtCmn600Generator.c                             |   2 +-
 DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c                                  |   2 +-
 DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c                                          |   2 +-
 DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c                                                |   2 +-
 DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c                                                    |   2 +-
 DynamicTablesPkg/Library/Common/DynamicPlatRepoLib/DynamicPlatRepo.c                                     |   4 +-
 DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.c                                       |   2 +-
 DynamicTablesPkg/Library/FdtHwInfoParserLib/Serial/ArmSerialPortParser.c                                 |   2 +-
 FatPkg/EnhancedFatDxe/FileSpace.c                                                                        |   2 +-
 FatPkg/EnhancedFatDxe/ReadWrite.c                                                                        |   2 +-
 FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c                                                 |   2 +-
 PrmPkg/Application/PrmInfo/PrmInfo.c                                                                     |   2 +-
 PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.c                                       |   2 +-
 PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c                                                                       |   2 +-
 PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTestImage.c    |   2 +-
 PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTestProtocol.c |   2 +-
 StandaloneMmPkg/Core/Dependency.c                                                                        |   2 +-
 StandaloneMmPkg/Core/Dispatcher.c                                                                        |  18 +--
 StandaloneMmPkg/Core/Handle.c                                                                            |   2 +-
 UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.c                   |  18 +--
 UnitTestFrameworkPkg/Library/UnitTestBootLibNull/UnitTestBootLibNull.c                                   |   2 +-
 UnitTestFrameworkPkg/Library/UnitTestBootLibUsbClass/UnitTestBootLibUsbClass.c                           |   2 +-
 UnitTestFrameworkPkg/Library/UnitTestLib/Log.c                                                           |   2 +-
 UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c                                                   |   2 +-
 UnitTestFrameworkPkg/Test/UnitTest/Sample/SampleUnitTest/SampleUnitTest.c                                |   2 +-
 .azurepipelines/templates/spell-check-prereq-steps.yml                                                   |   2 +-
 .pytool/Plugin/SpellCheck/cspell.base.yaml                                                               | 115 +++++++++++++++++++-
 ArmPkg/ArmPkg.ci.yaml                                                                                    |  53 ++++++++-
 ArmPkg/Include/Library/OemMiscLib.h                                                                      |   2 +-
 ArmVirtPkg/ArmVirtPkg.ci.yaml                                                                            |  25 +++--
 DynamicTablesPkg/DynamicTablesPkg.ci.yaml                                                                |  31 ++++--
 DynamicTablesPkg/Include/Library/DynamicPlatRepoLib.h                                                    |   4 +-
 DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.h                                          |   2 +-
 DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.h                                       |   2 +-
 DynamicTablesPkg/Library/FdtHwInfoParserLib/Serial/ArmSerialPortParser.h                                 |   2 +-
 DynamicTablesPkg/Readme.md                                                                               |   4 +-
 FatPkg/EnhancedFatDxe/Fat.h                                                                              |   2 +-
 FatPkg/FatPkg.ci.yaml                                                                                    |  22 +++-
 FmpDevicePkg/FmpDevicePkg.ci.yaml                                                                        |   4 +
 PrmPkg/Include/Library/PrmModuleDiscoveryLib.h                                                           |   2 +-
 PrmPkg/PrmLoaderDxe/PrmAcpiTable.h                                                                       |   4 +-
 PrmPkg/PrmPkg.ci.yaml                                                                                    |   9 ++
 PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTest.h         |   4 +-
 StandaloneMmPkg/Core/StandaloneMmCore.h                                                                  |   2 +-
 StandaloneMmPkg/Include/Guid/MmCoreData.h                                                                |   2 +-
 StandaloneMmPkg/StandaloneMmPkg.ci.yaml                                                                  |   9 ++
 UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h                                            |   2 +-
 UnitTestFrameworkPkg/PrivateInclude/UnitTestFrameworkTypes.h                                             |   2 +-
 UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml                                                        |  29 +++--
 55 files changed, 330 insertions(+), 107 deletions(-)

-- 
2.28.0.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#89856): https://edk2.groups.io/g/devel/message/89856
Mute This Topic: https://groups.io/mt/91176780/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-




More information about the edk2-devel-archive mailing list