public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Michael Kubacki" <mikuback@linux.microsoft.com>
To: devel@edk2.groups.io
Cc: Alexei Fedorov <Alexei.Fedorov@arm.com>,
	Ankit Sinha <ankit.sinha@intel.com>,
	Ard Biesheuvel <ardb+tianocore@kernel.org>,
	Bret Barkelew <Bret.Barkelew@microsoft.com>,
	Gerd Hoffmann <kraxel@redhat.com>,
	Guomin Jiang <guomin.jiang@intel.com>,
	Jiewen Yao <jiewen.yao@intel.com>,
	Leif Lindholm <quic_llindhol@quicinc.com>,
	Liming Gao <gaoliming@byosoft.com.cn>,
	Michael D Kinney <michael.d.kinney@intel.com>,
	Michael Kubacki <mikuback@linux.microsoft.com>,
	Nate DeSimone <nathaniel.l.desimone@intel.com>,
	Ray Ni <ray.ni@intel.com>, Sami Mujawar <sami.mujawar@arm.com>,
	Sean Brogan <sean.brogan@microsoft.com>,
	Supreeth Venkatesh <supreeth.venkatesh@arm.com>,
	Wei6 Xu <wei6.xu@intel.com>
Subject: [PATCH v2 00/11] Fix new typos reported
Date: Tue, 17 May 2022 20:13:27 -0400	[thread overview]
Message-ID: <20220518001338.1380-1-mikuback@linux.microsoft.com> (raw)

From: Michael Kubacki <michael.kubacki@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@arm.com>
Cc: Ankit Sinha <ankit.sinha@intel.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Cc: Gerd Hoffmann <kraxel@redhat.com>
Cc: Guomin Jiang <guomin.jiang@intel.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Michael Kubacki <mikuback@linux.microsoft.com>
Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Supreeth Venkatesh <supreeth.venkatesh@arm.com>
Cc: Wei6 Xu <wei6.xu@intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki@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


             reply	other threads:[~2022-05-18  0:14 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-18  0:13 Michael Kubacki [this message]
2022-05-18  0:13 ` [PATCH v2 01/11] PrmPkg: Fix new typos reported Michael Kubacki
2022-05-18  0:13 ` [PATCH v2 02/11] StandaloneMmPkg: " Michael Kubacki
2022-12-13 10:26   ` Sami Mujawar
2022-12-14  3:03     ` [edk2-devel] " Michael Kubacki
2022-05-18  0:13 ` [PATCH v2 03/11] DynamicTablesPkg: " Michael Kubacki
2022-05-18  0:13 ` [PATCH v2 04/11] UnitTestFrameworkPkg: " Michael Kubacki
2022-05-18  0:13 ` [PATCH v2 05/11] FatPkg: " Michael Kubacki
2022-05-18  0:13 ` [PATCH v2 06/11] FmpDevicePkg: " Michael Kubacki
2022-05-18  0:13 ` [PATCH v2 07/11] ArmPkg: Ignore " Michael Kubacki
2022-12-13 10:36   ` Sami Mujawar
2022-05-18  0:13 ` [PATCH v2 08/11] ArmVirtPkg: Add new ignored spelling errors Michael Kubacki
2022-12-13 10:38   ` Sami Mujawar
2022-05-18  0:13 ` [PATCH v2 09/11] .azurepipelines: Fix cspell version to v5.20.0 Michael Kubacki
2022-05-18  0:13 ` [PATCH v2 10/11] .pytool/plugin/SpellCheck: Allow compound words Michael Kubacki
2022-05-18  0:13 ` [PATCH v2 11/11] .pytool/plugin/SpellCheck: Add more common words Michael Kubacki

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220518001338.1380-1-mikuback@linux.microsoft.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox